Interface DataGridProps<T, C>

Receives the imperative GridApi. Accepts a ref object or a callback ref.

Extra classes on the grid's outer frame.

The columns to render.

Volatile app state handed to every cell renderer.

This is the escape hatch that keeps columns static: put in-flight ids, permission checks and event handlers here, and changing them re-renders cells without rebuilding a single column definition.

Where rows come from. Memoise it; a new identity causes a refetch.

Rows per page before the user changes it. A persisted preference wins.

The grouping before the user changes it, when uncontrolled. A grouping persisted under DataGridProps.storageKey wins, including a persisted "ungrouped".

Shown when a query returns no rows.

Base file name for CSV export, without the extension.

Show the always-visible filter inputs under the header. Free-text columns get a search box with a × button that clears that column's filter; other filter kinds show a read-only summary and are edited from the header popover.

Reads how many rows a group row stands for, shown beside its value. Return null to show no count.

Classes for one row's background, by its data -- e.g. to tint rows by status. A non-empty result replaces the striping; the editing and selected colours still win, and so does hover.

The colour must be opaque: the sticky selection and pinned cells paint the row's background, and a translucent one lets scrolled cells show through. As with cellClassName, the classes must be ones your Tailwind build can see.

Stable identity for a row, used for selection, editing and GridApi.updateRows. Must be stable across refetches.

Rows fetched each time a group is opened or its "Load more" is used.

Header height in pixels.

Height of the whole grid. Any CSS length; a number is treated as pixels.

Which rows may be selected. A row it returns false for keeps its checkbox, greyed out and inert, and is skipped by shift-ranges, by the header's select-all and by GridApi.selectAll.

An id selected while its row was selectable stays selected if the row later stops being so; call GridApi.clearSelection when that matters.

Called when a fetch or a commit throws. Aborted requests are not reported.

Enables row editing. Called when the user commits a row.

Return { ok: false, errors } to keep the row open and paint each message onto the cell whose column id it is keyed by.

Enables dropping files onto a row (e.g. to attach documents to it).

Called when the user groups or ungroups, from the header menu, the "Grouped by" chip, or GridApi.setRowGroup.

Called whenever the selection changes.

Page sizes offered in the pager.

The column id to group by, null for none — the controlled form. Leave it undefined to let the grid own the grouping (see DataGridProps.defaultRowGroupColId).

Grouping is single-level and done by the server: the grid asks for group rows, then for one group's rows as it is opened. See HxRowsRequest for both requests. A column id that is unknown or lacks ColumnDef.enableRowGroup is treated as null. Controlled grouping is not persisted.

Row height in pixels. Fixed for every row — that is what keeps virtualization O(1).

Show the checkbox selection column.

localStorage key for column layout, sort, filters and page size.

Omit it and nothing is persisted. Stored under hxg:<storageKey>.

Rendered into the toolbar strip above the header, left of the built-in Columns and Export CSV buttons. The built-in Export CSV exports the selection when there is one, otherwise every matching row, up to 1000; see GridApi.exportCsv.