@serenity-is/sleekgrid / EditorOptions

Interface: EditorOptions

Defined in: src/core/editing.ts:71

Options passed to every editor instance on construction.

Properties

cancelChanges()?

optional cancelChanges: () => void

Defined in: src/core/editing.ts:95

Callback to cancel pending editor changes.

Returns

void

---

column?

optional column: Column

Defined in: src/core/editing.ts:81

Column definition for the cell being edited.

---

columnMetaData?

optional columnMetaData: ColumnMetadata<any>

Defined in: src/core/editing.ts:83

Metadata overrides for the column/row being edited.

---

commitChanges()?

optional commitChanges: () => void

Defined in: src/core/editing.ts:93

Callback to commit pending editor changes.

Returns

void

---

compositeEditorOptions?

optional compositeEditorOptions: CompositeEditorOptions

Defined in: src/core/editing.ts:85

Options from a parent composite editor, if any.

---

container?

optional container: HTMLElement

Defined in: src/core/editing.ts:87

DOM container the editor should render into.

---

editorCellNavOnLRKeys?

optional editorCellNavOnLRKeys: boolean

Defined in: src/core/editing.ts:79

Whether left/right arrow keys should navigate between cells while editing.

---

event?

optional event: EventData

Defined in: src/core/editing.ts:91

Event that triggered the edit, if available.

---

grid

grid: EditorHost

Defined in: src/core/editing.ts:73

Host grid instance the editor operates within.

---

gridPosition?

optional gridPosition: Position

Defined in: src/core/editing.ts:75

Bounds of the entire grid container in viewport coordinates.

---

item?

optional item: any

Defined in: src/core/editing.ts:89

Data item (row) being edited.

---

position?

optional position: Position

Defined in: src/core/editing.ts:77

Bounds of the target cell where the editor should be positioned.