# GridEditorParams

Fields, allowed values, and APIs that use GridEditorParams.

Canonical: https://grid.syidax.com/docs/types/GridEditorParams/

<a id="definition"></a>

## 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.

```typescript
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;
}
```

<a id="used-by"></a>

## APIs using this type

- [getCellEditorInstance](https://grid.syidax.com/docs/methods/getCellEditorInstance.md) — Reads the mounted cell editor instance and context, or null if no editor exists.

<a id="parents"></a>

## Contracts containing this type

- [GridEditorDefinition](https://grid.syidax.com/docs/types/GridEditorDefinition.md)
- [GridEditorInstance](https://grid.syidax.com/docs/types/GridEditorInstance.md)
- [SyGridImperativeMethods](https://grid.syidax.com/docs/types/SyGridImperativeMethods.md)

<a id="related"></a>

## Related types

- [GridComponentParams](https://grid.syidax.com/docs/types/GridComponentParams.md)