Interface AriaTextsIf

The texts the table speaks to screen reader users: announcements of the live region (sorting, filter, copy, select all) and the accessible names of controls the table renders (row checkboxes, header group toggles).

The defaults are English (AriaTexts). Override single functions – e.g. for another language – with TableOptionsIf.ariaTexts; the others keep their default.

Every function returns plain text. It is written with textContent / setAttribute, never as HTML, so data in it (column labels, group labels) needs no escaping.

Example

const tableOptions: TableOptionsIf = {
  ...new TableOptions(),
  ariaTexts: {
    filtered: (rowCount: number) => `${rowCount} Zeilen`,
    sorted: (column: string, state: SortState) => state ? `Sortiert nach ${column}` : `Sortierung entfernt`,
  },
};

Since

1.1.91

See

Training: Accessible tables: keyboard and screen readers

Hierarchy

AriaTextsIf

Implemented by

AriaTexts

Methods

allSelected

allSelected(): string
Announced after Ctrl/⌘+A.

Returns string
default: "All cells selected"
- Defined in src/lib/table/aria/aria-texts.if.ts:58

`Optional` cellsFilled

cellsFilled(cellCount): string
Announced after a fill (fill handle, Ctrl/⌘+D, Ctrl/⌘+R) – optional, AriaTexts has a default.
Parameters
- cellCount: number
  the number of filled cells
Returns string
default: "3 cells filled"

Since
1.1.96
- Defined in src/lib/table/aria/aria-texts.if.ts:141

`Optional` changesCommitted

changesCommitted(cellCount): string
Announced after TableApi.commitBatchEdit.
Parameters
- cellCount: number
  the number of written cells
Returns string
default: "3 changes saved"

Since
1.1.96
- Defined in src/lib/table/aria/aria-texts.if.ts:168

`Optional` changesDiscarded

changesDiscarded(): string
Announced after TableApi.cancelBatchEdit.

Returns string
default: "Changes discarded"

Since
1.1.96
- Defined in src/lib/table/aria/aria-texts.if.ts:176

collapseGroup

collapseGroup(groupLabel): string
The accessible name of the toggle button of an expanded header group.
Parameters
- groupLabel: string
  the label of the group
Returns string
default: "Collapse group Q1"
- Defined in src/lib/table/aria/aria-texts.if.ts:96

`Optional` commitBlocked

commitBlocked(invalidCount): string
Announced when invalid values block TableApi.commitBatchEdit.
Parameters
- invalidCount: number
  the number of invalid cells
Returns string
default: "2 invalid values – nothing saved"

Since
1.1.96
- Defined in src/lib/table/aria/aria-texts.if.ts:185

copied

copied(cellCount): string
Announced after cells were copied to the clipboard (Ctrl/⌘+C, TableApi.copyToClipboard).
Parameters
- cellCount: number
  the number of copied cells
Returns string
default: "12 cells copied", "1 cell copied"
- Defined in src/lib/table/aria/aria-texts.if.ts:51

`Optional` detailCollapsed

detailCollapsed(): string
Announced after a detail row was collapsed (master/detail).

Returns string
default: "Details collapsed"

Since
1.1.97
- Defined in src/lib/table/aria/aria-texts.if.ts:210

`Optional` detailExpanded

detailExpanded(): string
Announced after a detail row was expanded (master/detail).

Returns string
default: "Details expanded"

Since
1.1.97
- Defined in src/lib/table/aria/aria-texts.if.ts:202

expandGroup

expandGroup(groupLabel): string
The accessible name of the toggle button of a collapsed header group.
Parameters
- groupLabel: string
  the label of the group
Returns string
default: "Expand group Q1"
- Defined in src/lib/table/aria/aria-texts.if.ts:88

`Optional` fillTooLarge

fillTooLarge(maxCells): string
Announced when a fill is refused because it covers too many cells (FillHandleOptionsIf.maxCells).
Parameters
- maxCells: number
  the limit
Returns string
default: "Too many cells to fill (at most 100000)"

Since
1.1.96
- Defined in src/lib/table/aria/aria-texts.if.ts:150

filtered

filtered(rowCount): string
Announced after the external filter changed (TableApi.externalFilterChanged).
Parameters
- rowCount: number
  the number of rows the body shows now
Returns string
default: "42 rows", "1 row", "No rows"
- Defined in src/lib/table/aria/aria-texts.if.ts:43

`Optional` invalidValue

invalidValue(message): string
Announced when an edited value is invalid (ColumnDefIf.validate) and not written (without batch edit).
Parameters
- message: string
  the message of the validator
Returns string
default: "Invalid value: <message>"

Since
1.1.96
- Defined in src/lib/table/aria/aria-texts.if.ts:194

`Optional` pendingChanges

pendingChanges(pendingCount): string
Announced after a value was marked in a batch edit (or set back).
Parameters
- pendingCount: number
  the number of pending cells
Returns string
default: "3 changes not saved", "No unsaved changes"

Since
1.1.96
- Defined in src/lib/table/aria/aria-texts.if.ts:159

`Optional` rowDragCancelled

rowDragCancelled(): string
Announced when a row drag was cancelled (Escape) – optional, AriaTexts has a default.

Returns string
default: "Drag cancelled"

Since
1.1.95
- Defined in src/lib/table/aria/aria-texts.if.ts:132

`Optional` rowDragStarted

rowDragStarted(rowCount): string
Announced when a row drag starts (optional – AriaTexts has a default).
Parameters
- rowCount: number
  number of dragged rows
Returns string
default: "Dragging 1 row. Press Escape to cancel."

Since
1.1.95
- Defined in src/lib/table/aria/aria-texts.if.ts:105

`Optional` rowMoveNotPossible

rowMoveNotPossible(): string
Announced when rows cannot be moved: the table is sorted or filtered (managed row drag), or the row cannot move further (optional – AriaTexts has a default).

Returns string
default: "Rows cannot be moved while the table is sorted or filtered"

Since
1.1.95
- Defined in src/lib/table/aria/aria-texts.if.ts:124

`Optional` rowMoved

rowMoved(position, rowCount): string
Announced after rows were moved by drag and drop or Ctrl+Alt+↑/↓ (optional – AriaTexts has a default).
Parameters
- position: number
  1-based position of the first moved row
- rowCount: number
  number of displayed rows
Returns string
default: "Row moved to position 7 of 20"

Since
1.1.95
- Defined in src/lib/table/aria/aria-texts.if.ts:115

selectAllRows

selectAllRows(): string
The accessible name of the checkbox in the header (checks all rows).

Returns string
default: "Select all rows"
- Defined in src/lib/table/aria/aria-texts.if.ts:80

selectRow

selectRow(rowNumber): string
The accessible name of the checkbox of a body row.
Parameters
- rowNumber: number
  1-based number of the row in the body
Returns string
default: "Select row 5"
- Defined in src/lib/table/aria/aria-texts.if.ts:73

selectionCleared

selectionCleared(): string
Announced after the selection was cleared by the keyboard (e.g. Ctrl+Shift+A).

Returns string
default: "Selection cleared"
- Defined in src/lib/table/aria/aria-texts.if.ts:65

sorted

sorted(columnLabel, sortState): string
Announced after a column was sorted (header double click, Enter on a header cell, TableApi.sortByColumn).
Parameters
- columnLabel: string
  the header label of the column
- sortState: SortState
  the new sort state, "" = unsorted
Returns string
default: "Sorted by Total, descending", "Sorting of Total removed"
- Defined in src/lib/table/aria/aria-texts.if.ts:35

Interface AriaTextsIf

Example

Since

See

Hierarchy

Implemented by

Index

Methods

Methods

allSelected

Returns string

Optional cellsFilled

Parameters

cellCount: number

Returns string

Since

Optional changesCommitted

Parameters

cellCount: number

Returns string

Since

Optional changesDiscarded

Returns string

Since

collapseGroup

Parameters

groupLabel: string

Returns string

Optional commitBlocked

Parameters

invalidCount: number

Returns string

Since

copied

Parameters

cellCount: number

Returns string

Optional detailCollapsed

Returns string

Since

Optional detailExpanded

Returns string

Since

expandGroup

Parameters

groupLabel: string

Returns string

Optional fillTooLarge

Parameters

maxCells: number

Returns string

Since

filtered

Parameters

rowCount: number

Returns string

Optional invalidValue

Parameters

message: string

Returns string

Since

Optional pendingChanges

Parameters

pendingCount: number

Returns string

Since

Optional rowDragCancelled

Returns string

Since

Optional rowDragStarted

Parameters

rowCount: number

Returns string

Since

Optional rowMoveNotPossible

Returns string

Since

Optional rowMoved

Parameters

position: number

`Optional` cellsFilled

`Optional` changesCommitted

`Optional` changesDiscarded

`Optional` commitBlocked

`Optional` detailCollapsed

`Optional` detailExpanded

`Optional` fillTooLarge

`Optional` invalidValue

`Optional` pendingChanges

`Optional` rowDragCancelled

`Optional` rowDragStarted

`Optional` rowMoveNotPossible

`Optional` rowMoved