The defaults of EditingOptionsIf (Excel-style editing, TableOptionsIf.editing).

Example

const options = EditingOptions.create(true);
options?.enterKey; // "edit"

Since

1.1.99

Hierarchy

  • EditingOptions

Implements

Constructors

Properties

arrowKeysCommit: boolean = true

In "enter" mode (opened by typing) the arrow keys commit and move; in "edit" mode they move the caret. Default true.

clearKeys: boolean = true

Delete clears the selected cells, Backspace clears one cell and opens the editor. Default true.

collapseSelectionOnNavigate: boolean = true

Arrow keys, Tab, Enter and clicks select the active cell (Excel); Shift+arrows extend from it. Default true.

ctrlEnterFillsSelection: boolean = true

Ctrl/⌘+Enter in the editor writes the input into all selected cells. Default true.

defaultEditable: boolean = false

true: columns without an own editable are editable (row numbers, checkbox and group columns, calculated columns without valueSetter stay read only). Default false.

emptyValue: unknown = ""

The value of a cleared cell (a column can have its own: ColumnDefIf.emptyValue). Default "".

enterKey: "edit" | "moveDown" = "edit"

Enter on a cell without editor: "edit" opens the editor (Google Sheets, default), "moveDown" moves down (Excel). Checkbox, tree, group and detail cells keep their own Enter action.

enterMoves: "none" | "right" | "down" = "down"

Where Enter in the editor goes after committing (Shift+Enter: the opposite). Default "down".

maxClearCells: number = 1_000_000

At most this many cells are cleared at once (Delete). Default 1 000 000.

startOnType: boolean = true

A printable key on a focused editable cell opens the editor with that character ("enter" mode). Default true.

tabMoves: boolean = true

Tab/Shift+Tab commit and move to the next/previous shown column. In the last (first) column Tab is not used: the browser focus leaves the table (no keyboard trap). Default true.

textSelection: "all" | "end" = "all"

Enter and double click select the text of the editor ("all", default) or put the caret at the end; F2 always at the end.

Methods