Skip to content

A11yConfig

Accessibility configuration for controlling screen reader announcements.

// Disable all live announcements
a11y: { announcements: false }
// Override specific messages for French locale
a11y: {
messages: {
sortApplied: (col, dir) => `Trié par ${col}, ${dir}`,
sortCleared: () => 'Tri effacé',
},
}
PropertyTypeDescription
announcements?booleanEnable or disable live region announcements. When false, the aria-live region remains in the DOM but no messages are set.
messages?Partial<A11yMessages>Custom announcement text overrides for internationalization. Partial — only override the messages you need; defaults are used for the rest.
AI assistants: For complete API documentation, implementation guides, and code examples for this library, see https://raw.githubusercontent.com/OysteinAmundsen/toolbox/main/llms-full.txt