Skip to content

A11yMessages

Since v2.0.0

Default announcement messages for screen reader live regions. Each function returns a localized string for a specific state change. Override individual messages via A11yConfig.messages for i18n.

PropertyTypeDescription
sortApplied(column: string, direction: string) => stringAnnounced when sorting is applied.
sortCleared() => stringAnnounced when sorting is cleared.
filterApplied(column: string) => stringAnnounced when a filter is applied.
filterCleared(column: string) => stringAnnounced when a filter is cleared from a column.
allFiltersCleared() => stringAnnounced when all filters are cleared.
groupExpanded(name: string, count: number) => stringAnnounced when a group row is expanded.
groupCollapsed(name: string) => stringAnnounced when a group row is collapsed.
selectionChanged(count: number) => stringAnnounced when row selection changes.
selectAllRows() => stringAccessible name for the header “select all rows” checkbox. v3.7.0+
selectRow(rowIndex: number) => stringAccessible name for a row’s selection checkbox. rowIndex is zero-based. v3.7.0+
columnSelected(label: string) => stringAnnounced when a single column is selected. v2.8.0+
columnSelectionChanged(count: number) => stringAnnounced when multiple columns are selected. v2.8.0+
columnSelectionCleared() => stringAnnounced when column selection is cleared. v2.8.0+
selectionAxisChanged(toAxis: row | column) => stringAnnounced when the active selection axis flips between row and column. v2.8.0+
editingStarted(rowIndex: number) => stringAnnounced when row editing starts.
editingCommitted(rowIndex: number) => stringAnnounced when row editing is committed.
dataLoaded(count: number) => stringAnnounced when data is loaded.