Navigated to /docs/ui/api/accessibility

Accessibility audits API

Component and theme accessibility audit functions, issues, severities, and result contracts.

Accessibility audits exports

4 public exports from @tavojs/ui/a11y.

@tavojs/ui/a11y

Canonical import boundary for every symbol in this section.

A11yAuditIssue#

type A11yAuditIssue = {
    id: string;
    severity: A11yAuditSeverity;
    message: string;
    target?: string;
};

Public type exported from @tavojs/ui/a11y.

Related guide

A11yAuditResult#

type A11yAuditResult = {
    passed: boolean;
    issues: A11yAuditIssue[];
};

Public type exported from @tavojs/ui/a11y.

Related guide

A11yAuditSeverity#

type A11yAuditSeverity = "error" | "warning" | "info";

Public type exported from @tavojs/ui/a11y.

Related guide

auditThemeA11y#

auditThemeA11y(config: TavoUiThemeConfig): A11yAuditResult

Public function exported from @tavojs/ui/a11y.

Related guide