Editable
A column-level property that controls editability of cells.
- Use
trueto enable editing for all rows. - Use EditableFn for conditional, row-specific editability.
Type
boolean | EditableFn
Variants
booleanEditableFn(docs)
EditableFn
A predicate function that determines whether a particular cell is editable.
If cell editing is enabled in LyteNyte Grid, this function is evaluated per cell. Use
true for globally editable columns or EditableFn for row-specific logic.
Parameters
params | EditableFnParams (docs) |
Returns
boolean
EditableFnParams
Parameters passed to EditableFn , the predicate function used to determine if a specific cell in the grid is editable.
These include the row index, the row node object, the grid instance, and the column definition.
column
propertyA reference to a column definition in LyteNyte Grid.
| Type | Column |
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
row
propertyThe row node instance in LyteNyte Grid.
| Type | RowNode |
rowIndex
propertyThe zero-based index of the row.
Type
number
EditActivePosition
Describes the currently active cell position if editing is in progress.
When no edit is active, this will be undefined .
column
propertyA reference to a column definition in LyteNyte Grid.
| Type | Column |
rowIndex
propertyThe zero-based index of the row.
Type
number
EditBeginParams
Parameters accepted by the editBegin method to start editing a specific cell.
column
propertyA flexible reference to a column, which can be a column object, its id (string), or its index (number).
Type
string | number | Column
Variants
stringnumberColumn(docs)
init
propertyOptional override value to use as the initial edit value. Defaults to the cell's current value.
Type
any
rowIndex
propertyThe zero-based index of the row.
Type
number
EditCellMode
Controls whether a grid operates in inline editing mode:
"cell": Editing is active and inline"readonly": Editing is disabled entirely
Type
"cell" | "readonly"
Variants
"cell""readonly"
EditClickActivator
Specifies what kind of mouse interaction should initiate editing:
"single": Single click"double-click": Double click"none": Editing must be started via API or programmatically
Type
"single" | "double-click" | "none"
Variants
"single""double-click""none"
EditRenderer
Defines the edit renderer for a column.
Can be either:
- A string key referencing a registered editor component
- A function of type EditRendererFn for custom rendering logic
Type
string | EditRendererFn
Variants
stringEditRendererFn(docs)
EditRendererFn
A function that returns a React component to be rendered in edit mode for a given cell.
Used for customizing editing UI. If omitted, a default HTML input will be used.
Parameters
params | EditRendererFnParams (docs) |
Returns
ReactNode
EditRendererFnParams
Input parameters for the EditRendererFn , used to render the edit UI for a cell.
These include positional and contextual data such as row, column, value, and grid instance, along with row validation status and change handlers.
column
propertyA reference to a column definition in LyteNyte Grid.
| Type | Column |
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
onChange
propertyA callback that must be called with the new value when the user changes the input.
This triggers internal grid state updates and row validation.
Parameters
c | any |
Returns
void
row
propertyThe row node instance in LyteNyte Grid.
| Type | RowNode |
rowIndex
propertyThe zero-based index of the row.
Type
number
rowValidationState
propertyTracks the row's current validation status while editing.
false: validation failedtrueornull: validation passed or hasn't runRecord<string, any>: failed with details per column
Type
null | boolean | Record
Variants
nullbooleanRecord
value
propertyThe value currently being edited in the active cell.
Managed internally by the grid, but should be aligned with the expected shape of your application's data model.
Type
any
EditRowValidatorFn
A function that validates a fully edited row.
Supports synchronous or object-based results for per-column validation. Must return:
trueornullif the row is validfalseor aRecord<string, any>describing errors if invalid
Parameters
params | EditRowValidatorFnParams (docs) |
Returns
Record | boolean
EditRowValidatorFnParams
Input arguments passed to EditRowValidatorFn .
Used to perform validation on the entire row during or after edit submission.
data
propertyThe row data to validate.
Type
any
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
row
propertyThe row node instance in LyteNyte Grid.
| Type | RowNode |
rowIndex
propertyThe zero-based index of the row.
Type
number
EditSetterFn
A function that returns a new row object based on the edited cell value.
Required when dealing with nested, computed, or non-primitive values that the grid cannot update automatically.
Parameters
params | EditSetterParams (docs) |
Returns
any
EditSetterParams
Input parameters passed to an EditSetterFn .
Provides the context needed to compute and apply new row data based on edit input.
column
propertyA reference to a column definition in LyteNyte Grid.
| Type | Column |
data
propertyThe new row data after applying edits. This is an intermediate representation, not yet committed to the grid.
Type
any
grid
propertyA reference to the LyteNyte Grid instance.
| Type | Grid |
row
propertyThe row node instance in LyteNyte Grid.
| Type | RowNode |
rowIndex
propertyThe zero-based index of the row.
Type
number
value
propertyThe current edit value of the cell being edited. Useful when the cell is derived from data and not actually present in the row data.
Type
any
EditUpdateParams
Parameters passed to the editUpdate method, used to submit a value change.
column
propertyA flexible reference to a column, which can be a column object, its id (string), or its index (number).
Type
string | number | Column
Variants
stringnumberColumn(docs)
rowIndex
propertyThe zero-based index of the row.
Type
number
value
propertyThe value to apply to the cell. It will go through normal validation and update handling.
Type
any