Documentation

@kanunilabs/datagrid-react


@kanunilabs/datagrid-react / GridKeyContext

Interface: GridKeyContext

What the app's onKeyDown hook is told about the grid (P-7.2).

Properties

cell

cell: GridKeyCell | null

The open editor's cell, else the focused cell; null when neither.


editing

editing: boolean

A cell editor (or, in a row mode, a row) is open.


isNewRow

isNewRow: boolean

cell's row was added and is not saved yet.

Methods

cancel()

cancel(): void

Close the open editor without keeping its value.

Returns

void


commit()

commit(): boolean

Commit the open cell editor — the value being typed becomes the cell's (pending) value. True when nothing was open or the value was taken; false when a rule refused it (the editor stays open) or a whole row is open in a row mode (save that with api.saveChanges()).

Returns

boolean