API REFERENCE
GridEditorParams
Fields, allowed values, and APIs that use GridEditorParams.
Type definition
A question mark (?) marks an optional field; readonly marks a value you should not change directly. A union (|) accepts one of the listed forms. Functions are callbacks that Grid invokes at the relevant point.
export interface GridEditorParams<
TData = Record<string, unknown>,
TValue = unknown,
TContext = unknown,
> extends GridComponentParams<TContext> {
readonly value: TValue;
readonly data: Readonly<TData>;
readonly rowIndex: number;
readonly colId: string;
readonly cellElement?: HTMLElement;
readonly startedBy: 'keyboard' | 'mouse' | 'api';
readonly event: Event | null;
readonly stopEditing: (cancel?: boolean) => void;
}APIs using this type
- getCellEditorInstance
Reads the mounted cell editor instance and context, or null if no editor exists.