@kanunilabs/datagrid-react / GridNotesConfig

Interface: GridNotesConfig<TRow>

Defined in: datagrid-react/src/types.ts:167

Cell notes — prose a USER attached to a cell, Excel-style (gap analysis P3.3).

Not a tooltip and not a value. A tooltip describes what the cell already says; a note is something a person added that is not in the data, so it carries a visible marker — you can see which cells have one without hovering every cell to find out.

Storage is the application's. The grid renders notes, reveals them 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-react/src/types.ts:175

This cell's note, or null.

Called for every RENDERED cell, so make it a lookup — a Map keyed by ${rowKey}:${columnId} is the shape that fits. Anything that scans per call turns a viewport into quadratic work.

Parameters

ctx

NoteCellContext<TRow>

Returns

string | null | undefined

menu?

optional menu?: boolean

Defined in: datagrid-react/src/types.ts:191

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

Turn it off to place the items yourself — the grid's own menu entries are a convenience, not the only way in.

onChange?

optional onChange?: (ctx) => void

Defined in: datagrid-react/src/types.ts:183

The user changed a note; text is null when they cleared it.

Its PRESENCE is what makes notes editable: without it the grid shows notes and offers no way to write one, which is the right behaviour for a grid displaying notes that came from somewhere else.

Parameters

ctx

NoteCellContext<TRow> & object

Returns

void