Class SelectCellEditor

Editor with a fixed list of values (select). ↑/↓ choose, Alt+↓ opens the list, typing jumps to the first matching entry (browser behaviour), Enter commits.

Example

ColumnDef.create({
  property: "status", editable: TrueFn,
  editor: () => SelectCellEditor.create(["open", "paid", "void"]),
});

Since

1.1.99

Hierarchy

SelectCellEditor

Implements

CellEditorIf

Index

Constructors

constructor

new SelectCellEditor(options): SelectCellEditor
Parameters
- options: ValueLabelIf[]
Returns SelectCellEditor
- Defined in src/lib/table/sheet-editing/editors/select-cell-editor.ts:22

Properties

`Protected` `Readonly` options

options: ValueLabelIf[]

Methods

close

close(): void
Removes listeners and elements.

Returns void
Implementation of CellEditorIf.close
- Defined in src/lib/table/sheet-editing/editors/select-cell-editor.ts:89

focus

focus(): void
Gives the input element the keyboard focus.

Returns void
Implementation of CellEditorIf.focus
- Defined in src/lib/table/sheet-editing/editors/select-cell-editor.ts:71

getFocusElement

getFocusElement(): undefined | HTMLElement
The element that has the focus (the table names it and lets the active cell own it for screen readers).

Returns undefined | HTMLElement
Implementation of CellEditorIf.getFocusElement
- Defined in src/lib/table/sheet-editing/editors/select-cell-editor.ts:77

getText

getText(): string
The text of the editor, e.g. "=B2*C2" (formula input, later stages).

Returns string
Implementation of CellEditorIf.getText
- Defined in src/lib/table/sheet-editing/editors/select-cell-editor.ts:67

getValue

getValue(): unknown
The value to write (it runs through editInputPipe and validate of the column).

Returns unknown
Implementation of CellEditorIf.getValue
- Defined in src/lib/table/sheet-editing/editors/select-cell-editor.ts:59

open

open(container, ctx): void
Builds the editor into container (the table positions the container over the cell).
Parameters
- container: HTMLDivElement
- ctx: CellEditorContextIf
Returns void
Implementation of CellEditorIf.open
- Defined in src/lib/table/sheet-editing/editors/select-cell-editor.ts:35

wantsKey

wantsKey(evt, _mode): boolean
true if the editor needs this key itself (e.g. ↑/↓ in a list) – the table does not commit then.
Parameters
- evt: KeyboardEvent
- _mode: CellEditMode
Returns boolean
Implementation of CellEditorIf.wantsKey
- Defined in src/lib/table/sheet-editing/editors/select-cell-editor.ts:81

`Static` create

create(values): SelectCellEditor
An editor whose values are their own labels.
Parameters
- values: string[]
  the entries
Returns SelectCellEditor
the editor
- Defined in src/lib/table/sheet-editing/editors/select-cell-editor.ts:31

Class SelectCellEditor

Example

Since

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

options: ValueLabelIf[]

Returns SelectCellEditor

Properties

Protected Readonly options

Methods

close

Returns void

focus

Returns void

getFocusElement

Returns undefined | HTMLElement

getText

Returns string

getValue

Returns unknown

open

Parameters

container: HTMLDivElement

ctx: CellEditorContextIf

Returns void

wantsKey

Parameters

evt: KeyboardEvent

_mode: CellEditMode

Returns boolean

Static create

Parameters

values: string[]

Returns SelectCellEditor

Settings

Member Visibility

Theme

On This Page

`Protected` `Readonly` options

`Static` create