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

cellsCleared

cellsCleared(cellCount): string
Announced after Delete/Backspace cleared cells.
Parameters
- cellCount: number
  the number of cleared cells
Returns string
default: "8 cells cleared"

Since
1.1.99
Implementation of AriaTextsIf.cellsCleared
- Defined in src/lib/table/aria/aria-texts.ts:139

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

cellsPasted

cellsPasted(cellCount, skippedCount): string
Announced after Ctrl/⌘+V (copy, cut and paste, tableOptions.clipboard).
Parameters
- cellCount: number
  the number of pasted cells
- skippedCount: number
  cells left out (read only, invalid, cut off at the last column)
Returns string
default: "6 cells pasted", "4 cells pasted, 2 skipped"

Since
1.1.99
Implementation of AriaTextsIf.cellsPasted
- Defined in src/lib/table/aria/aria-texts.ts:165

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

clearTooLarge

clearTooLarge(maxCells): string
Announced when more cells should be cleared than EditingOptionsIf.maxClearCells allows.
Parameters
- maxCells: number
  the limit
Returns string
default: "Too many cells to clear (at most 1000000)"

Since
1.1.99
Implementation of AriaTextsIf.clearTooLarge
- Defined in src/lib/table/aria/aria-texts.ts:143

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

columnSelected

columnSelected(columnCount): string
Announced after Ctrl+Space selected the columns of the active cell.
Parameters
- columnCount: number
  number of selected columns
Returns string
default: "Column selected"

Since
1.1.99
Implementation of AriaTextsIf.columnSelected
- Defined in src/lib/table/aria/aria-texts.ts:157

columnsDeleted

columnsDeleted(count): string
Announced after columns were deleted (TableApi.deleteColumns).
Parameters
- count: number
  the columns
Returns string
default: "2 columns deleted"

Since
1.1.99
Implementation of AriaTextsIf.columnsDeleted
- Defined in src/lib/table/aria/aria-texts.ts:234

columnsInserted

columnsInserted(count): string
Announced after columns were inserted (TableApi.insertColumns).
Parameters
- count: number
  the columns
Returns string
default: "2 columns inserted"

Since
1.1.99
Implementation of AriaTextsIf.columnsInserted
- Defined in src/lib/table/aria/aria-texts.ts:230

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

copiedLastRangeOnly

copiedLastRangeOnly(): string
Announced when several ranges are selected and only the last one is copied (like Google Sheets).

Returns string
default: "Only the last selected range was copied"

Since
1.1.99
Implementation of AriaTextsIf.copiedLastRangeOnly
- Defined in src/lib/table/aria/aria-texts.ts:182

copyTooLarge

copyTooLarge(maxCells): string
Announced when more cells should be copied than CopyService.maxCopyCells allows.
Parameters
- maxCells: number
  the limit
Returns string
default: "Too many cells to copy (at most 1000000)"

Since
1.1.99
Implementation of AriaTextsIf.copyTooLarge
- Defined in src/lib/table/aria/aria-texts.ts:174

cutMarked

cutMarked(cellCount): string
Announced after Ctrl/⌘+X: the cells are marked and move on the next paste.
Parameters
- cellCount: number
  the number of cut cells
Returns string
default: "6 cells cut, paste to move them"

Since
1.1.99
Implementation of AriaTextsIf.cutMarked
- Defined in src/lib/table/aria/aria-texts.ts:178

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

editingStarted

editingStarted(columnLabel): string
Announced when the cell editor opens (Excel-style editing).
Parameters
- columnLabel: string
  the column label
Returns string
default: "Editing Price"

Since
1.1.99
Implementation of AriaTextsIf.editingStarted
- Defined in src/lib/table/aria/aria-texts.ts:131

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

formulaError

formulaError(message): string
Announced when a cell formula with a syntax error is stored (it shows #ERROR!, tableOptions.cellFormulas).
Parameters
- message: string
  the parser's message
Returns string
default: "Formula error: <message>"

Since
1.1.99
Implementation of AriaTextsIf.formulaError
- Defined in src/lib/table/aria/aria-texts.ts:210

functionSuggestions

functionSuggestions(): string
The label of the list of function suggestions while a cell formula is typed.

Returns string
default: "Functions"

Since
1.1.99
Implementation of AriaTextsIf.functionSuggestions
- Defined in src/lib/table/aria/aria-texts.ts:214

gridEditingHint

gridEditingHint(): string
The description of the grid with Excel-style editing (aria-description of the host): how it is used.

Returns string
default: "Type to edit a cell, Enter to edit or commit, Escape to cancel. Tab in the last column leaves the table."

Since
1.1.99
Implementation of AriaTextsIf.gridEditingHint
- Defined in src/lib/table/aria/aria-texts.ts:161

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

nothingToRedo

nothingToRedo(): string
Returns string
default: "Nothing to redo"

Since
1.1.99
Implementation of AriaTextsIf.nothingToRedo
- Defined in src/lib/table/aria/aria-texts.ts:198

nothingToUndo

nothingToUndo(): string
Returns string
default: "Nothing to undo"

Since
1.1.99
Implementation of AriaTextsIf.nothingToUndo
- Defined in src/lib/table/aria/aria-texts.ts:194

pasteTooLarge

pasteTooLarge(maxCells): string
Announced when more cells should be pasted than ClipboardOptionsIf.maxPasteCells allows.
Parameters
- maxCells: number
  the limit
Returns string
default: "Too many cells to paste (at most 1000000)"

Since
1.1.99
Implementation of AriaTextsIf.pasteTooLarge
- Defined in src/lib/table/aria/aria-texts.ts:170

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

rangeSelected

rangeSelected(rowCount, columnCount): string
Announced when Shift+arrows change the selected range (the focus stays on the active cell).
Parameters
- rowCount: number
  rows of the range
- columnCount: number
  shown columns of the range
Returns string
default: "3 rows, 2 columns selected"

Since
1.1.99
Implementation of AriaTextsIf.rangeSelected
- Defined in src/lib/table/aria/aria-texts.ts:147

readOnlyCell

readOnlyCell(): string
Announced when a key is typed on a cell that cannot be edited (Excel-style editing).

Returns string
default: "Read only"

Since
1.1.99
Implementation of AriaTextsIf.readOnlyCell
- Defined in src/lib/table/aria/aria-texts.ts:135

redone

redone(label, cellCount): string
Announced after Ctrl+Y / Ctrl/⌘+Shift+Z.
Parameters
- label: string
  the step
- cellCount: number
  cells written again
Returns string
default: "Redo Paste, 6 cells"

Since
1.1.99
Implementation of AriaTextsIf.redone
- Defined in src/lib/table/aria/aria-texts.ts:190

referenceInserted

referenceInserted(reference): string
Announced when a reference is inserted by pointing (arrow keys or a click while typing a formula).
Parameters
- reference: string
  e.g. "B2" or "B2:B4"
Returns string
default: the reference

Since
1.1.99
Implementation of AriaTextsIf.referenceInserted
- Defined in src/lib/table/aria/aria-texts.ts:218

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

rowSelected

rowSelected(rowCount): string
Announced after Shift+Space selected the rows of the active cell.
Parameters
- rowCount: number
  number of selected rows
Returns string
default: "Row selected"

Since
1.1.99
Implementation of AriaTextsIf.rowSelected
- Defined in src/lib/table/aria/aria-texts.ts:153

rowsDeleted

rowsDeleted(count): string
Announced after rows were deleted (TableApi.deleteRows).
Parameters
- count: number
  the rows
Returns string
default: "3 rows deleted"

Since
1.1.99
Implementation of AriaTextsIf.rowsDeleted
- Defined in src/lib/table/aria/aria-texts.ts:226

rowsInserted

rowsInserted(count): string
Announced after rows were inserted (TableApi.insertRows).
Parameters
- count: number
  the rows
Returns string
default: "3 rows inserted"

Since
1.1.99
Implementation of AriaTextsIf.rowsInserted
- Defined in src/lib/table/aria/aria-texts.ts:222

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

undoHistoryCleared

undoHistoryCleared(maxCells): string
Announced when one change has more cells than UndoOptionsIf.maxCells: the history is emptied.
Parameters
- maxCells: number
  the limit
Returns string
default: "This change cannot be undone (more than 1000000 cells)"

Since
1.1.99
Implementation of AriaTextsIf.undoHistoryCleared
- Defined in src/lib/table/aria/aria-texts.ts:206

undoSkipped

undoSkipped(cellCount): string
Added to the undo/redo announcement when cells were left out (changed meanwhile, row gone, read only).
Parameters
- cellCount: number
  cells left out
Returns string
default: "2 cells skipped"

Since
1.1.99
Implementation of AriaTextsIf.undoSkipped
- Defined in src/lib/table/aria/aria-texts.ts:202

undone

undone(label, cellCount): string
Announced after Ctrl/⌘+Z (undo and redo, tableOptions.undo).
Parameters
- label: string
  the step: "Edit", "Paste", "Fill" …
- cellCount: number
  cells written back
Returns string
default: "Undo Paste, 6 cells"

Since
1.1.99
Implementation of AriaTextsIf.undone
- Defined in src/lib/table/aria/aria-texts.ts:186

`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

cellsCleared

Parameters

cellCount: number

Returns string

Since

cellsFilled

Parameters

cellCount: number

Returns string

Since

cellsPasted

Parameters

cellCount: number

skippedCount: number

Returns string

Since

changesCommitted

Parameters

cellCount: number

Returns string

Since

changesDiscarded

Returns string

Since

clearTooLarge

Parameters

maxCells: number

Returns string

Since

collapseGroup

Parameters

groupLabel: string

Returns string

columnSelected

Parameters

columnCount: number

Returns string

Since

columnsDeleted

Parameters

count: number

Returns string

Since

columnsInserted

Parameters

count: number

Returns string

Since

commitBlocked

Parameters

invalidCount: number

Returns string

Since

copied

Parameters

cellCount: number

Returns string

copiedLastRangeOnly

Returns string

Since

copyTooLarge

Parameters

maxCells: number

Returns string

Since

cutMarked