@quartix/grid

Props Reference

Detailed documentation for the DataGrid component props. Use these to customize behavior, appearance, and interactivity.

Core Props

NameTypeDefaultDescription
dataGridRow[]-Array of objects to display in the grid.
columnsGridColumn[]-Column definitions including keys, headers, and renderers.
licenseKeystring-Required license key for the grid component.

Layout Props

NameTypeDefaultDescription
heightnumber-Fixed height of the grid in pixels.
rowHeightnumber40Fixed height for each row in pixels.
density'sm' | 'md' | 'lg''md'Controls vertical padding and spacing within rows.

Features Props

NameTypeDefaultDescription
selectablebooleanfalseEnables row selection with checkboxes.
sortablebooleanfalseGlobal toggle for column sorting.
filterablebooleanfalseGlobal toggle for column header filtering.
groupablebooleanfalseGlobal toggle for row grouping features.
virtualizedbooleantrueEnables vertical virtualization for high performance.
showToolbarbooleantrueToggles visibility of the top action toolbar.

Pagination Props

NameTypeDefaultDescription
paginationPaginationOptions-Configuration for client or server-side pagination.

Events Props

NameTypeDefaultDescription
onRowClick(params: RowEventParams) => void-Callback fired when a row is clicked.
onCellEdit(params: CellEditParams) => void-Fired when an inline edit is committed.
💡

Performance Tuning

For huge datasets (>10k rows), check out the performanceConfig prop to fine-tune virtualization thresholds, worker-based sorting, and search-cache behavior.