Documentation

Interface: GridNotesConfig<TRow>

Defined in: datagrid/src/createGrid.ts:272

Cell notes (P3.3) — the React GridNotesConfig, verbatim. The grid SHOWS notes (marker + tooltip) and, with onChange, collects edits; it does not decide where they live, because a note that survives a reload has to go somewhere only the app knows about.

Type Parameters

TRow

TRow = GridRowData

Properties

get

get: (ctx) => string | null | undefined

Defined in: datagrid/src/createGrid.ts:274

This cell's note, or null. Called for every RENDERED cell — make it a lookup.

Parameters

ctx

NoteCellContext<TRow>

Returns

string | null | undefined

menu?

optional menu?: boolean

Defined in: datagrid/src/createGrid.ts:278

Append add/edit/delete items to the row context menu. Default true when onChange is given.

onChange?

optional onChange?: (ctx) => void

Defined in: datagrid/src/createGrid.ts:276

The user changed a note; text is null when they cleared it. Its PRESENCE makes notes editable.

Parameters

ctx

NoteCellContext<TRow> & object

Returns

void