Skip to content

Vizel API / core/src / VizelAriaContract

Interface: VizelAriaContract

Defined in: packages/core/src/feature-manifest.ts:67

Accessibility contract for a feature's root element.

scripts/check-aria-contract.ts statically enforces this contract: it resolves each adapter component for the feature and asserts that the declared role and every requiredAttributes entry appears in the component source — either as a literal attribute or through the feature's resolved builder spec. The check verifies presence in source, not the rendered Document Object Model (DOM).

Runtime enforcement (axe assertions and keyboard-interaction tests on the live DOM) is planned as Phase 2 and is deferred to the accessibility Continuous Integration (CI) follow-up; this contract does not yet guarantee runtime behaviour.

Properties

requiredAttributes

ts
readonly requiredAttributes: readonly string[];

Defined in: packages/core/src/feature-manifest.ts:71

Attributes the feature exposes for accessibility.


role?

ts
readonly optional role?: string;

Defined in: packages/core/src/feature-manifest.ts:69

Optional ARIA role applied to the feature's root element.

Released under the MIT License.