API REFERENCE
GridEditorInstance
Fields, allowed values, and APIs that use GridEditorInstance.
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 GridEditorInstance<
TData = Record<string, unknown>,
TValue = unknown,
TContext = unknown,
> extends GridGuiComponent<
GridEditorParams<TData, TValue, TContext>,
HTMLElement
> {
afterGuiAttached?(): GridMaybePromise<void>;
getValue(): GridMaybePromise<TValue>;
isCancelBeforeStart?(): GridMaybePromise<boolean>;
isCancelAfterEnd?(): GridMaybePromise<boolean>;
isPopup?(): boolean;
getPopupPosition?(): 'over' | 'under';
getValidationErrors?(
value: TValue,
): GridMaybePromise<ReadonlyArray<GridEditorValidationError> | null>;
focusIn?(): void;
focusOut?(): void;
}APIs using this type
- getCellEditorInstance
Reads the mounted cell editor instance and context, or null if no editor exists.