Class AriaTexts

The English default texts for screen readers (see AriaTextsIf).

The table uses AriaTexts.create(tableOptions.ariaTexts): your functions replace the defaults one by one.

Example

const texts = AriaTexts.create({ copied: (n: number) => `${n} Zellen kopiert` });
texts.copied(3);       // "3 Zellen kopiert"
texts.filtered(42);    // "42 rows" (default)

Since

1.1.91

Hierarchy

AriaTexts

Implements

AriaTextsIf

Constructors

constructor

new AriaTexts(): AriaTexts
Returns AriaTexts

Methods

allSelected

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

Returns string
default: "All cells selected"
Implementation of AriaTextsIf.allSelected
- Defined in src/lib/table/aria/aria-texts.ts:54

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
Implementation of AriaTextsIf.cellsFilled
- Defined in src/lib/table/aria/aria-texts.ts:94

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
Implementation of AriaTextsIf.changesCommitted
- Defined in src/lib/table/aria/aria-texts.ts:115

changesDiscarded

changesDiscarded(): string
Announced after TableApi.cancelBatchEdit.

Returns string
default: "Changes discarded"

Since
1.1.96
Implementation of AriaTextsIf.changesDiscarded
- Defined in src/lib/table/aria/aria-texts.ts:119

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"
Implementation of AriaTextsIf.collapseGroup
- Defined in src/lib/table/aria/aria-texts.ts:74

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
Implementation of AriaTextsIf.commitBlocked
- Defined in src/lib/table/aria/aria-texts.ts:123

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"
Implementation of AriaTextsIf.copied
- Defined in src/lib/table/aria/aria-texts.ts:50

detailCollapsed

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

Returns string
default: "Details collapsed"

Since
1.1.97
Implementation of AriaTextsIf.detailCollapsed
- Defined in src/lib/table/aria/aria-texts.ts:102

detailExpanded

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

Returns string
default: "Details expanded"

Since
1.1.97
Implementation of AriaTextsIf.detailExpanded
- Defined in src/lib/table/aria/aria-texts.ts:98

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"
Implementation of AriaTextsIf.expandGroup
- Defined in src/lib/table/aria/aria-texts.ts:70

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
Implementation of AriaTextsIf.fillTooLarge
- Defined in src/lib/table/aria/aria-texts.ts:106

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"
Implementation of AriaTextsIf.filtered
- Defined in src/lib/table/aria/aria-texts.ts:45

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
Implementation of AriaTextsIf.invalidValue
- Defined in src/lib/table/aria/aria-texts.ts:127

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
Implementation of AriaTextsIf.pendingChanges
- Defined in src/lib/table/aria/aria-texts.ts:110

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
Implementation of AriaTextsIf.rowDragCancelled
- Defined in src/lib/table/aria/aria-texts.ts:90

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
Implementation of AriaTextsIf.rowDragStarted
- Defined in src/lib/table/aria/aria-texts.ts:78

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
Implementation of AriaTextsIf.rowMoveNotPossible
- Defined in src/lib/table/aria/aria-texts.ts:86

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
Implementation of AriaTextsIf.rowMoved
- Defined in src/lib/table/aria/aria-texts.ts:82

selectAllRows

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

Returns string
default: "Select all rows"
Implementation of AriaTextsIf.selectAllRows
- Defined in src/lib/table/aria/aria-texts.ts:66

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"
Implementation of AriaTextsIf.selectRow
- Defined in src/lib/table/aria/aria-texts.ts:62

selectionCleared

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

Returns string
default: "Selection cleared"
Implementation of AriaTextsIf.selectionCleared
- Defined in src/lib/table/aria/aria-texts.ts:58

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"
Implementation of AriaTextsIf.sorted
- Defined in src/lib/table/aria/aria-texts.ts:39

`Static` create

create(overrides?): AriaTextsIf
The default texts, overridden by the given functions.
Parameters
- Optional overrides: Partial<AriaTextsIf>
  functions that replace the English defaults (e.g. tableOptions.ariaTexts)
Returns AriaTextsIf
a complete set of texts
- Defined in src/lib/table/aria/aria-texts.ts:25

Class AriaTexts

Example

Since

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Returns AriaTexts

Methods

allSelected

Returns string

cellsFilled

Parameters

cellCount: number

Returns string

Since

changesCommitted

Parameters

cellCount: number

Returns string

Since

changesDiscarded

Returns string

Since

collapseGroup

Parameters

groupLabel: string

Returns string

commitBlocked

Parameters

invalidCount: number

Returns string

Since

copied

Parameters

cellCount: number

Returns string

detailCollapsed

Returns string

Since

detailExpanded

Returns string

Since

expandGroup

Parameters

groupLabel: string

Returns string

fillTooLarge

Parameters

maxCells: number

Returns string

Since

filtered

Parameters

rowCount: number

Returns string

invalidValue

Parameters

message: string

Returns string

Since

pendingChanges

Parameters

pendingCount: number

Returns string

Since

rowDragCancelled

Returns string

Since

rowDragStarted

Parameters

rowCount: number

Returns string

Since

rowMoveNotPossible

Returns string

Since

`Static` create

`Optional` overrides: Partial<AriaTextsIf>