Props Reference
Detailed documentation for the DataGrid component props. Use these to customize behavior, appearance, and interactivity.
Core Props
| Name | Type | Default | Description |
|---|---|---|---|
| data | GridRow[] | - | Array of objects to display in the grid. |
| columns | GridColumn[] | - | Column definitions including keys, headers, and renderers. |
| licenseKey | string | - | Required license key for the grid component. |
Layout Props
| Name | Type | Default | Description |
|---|---|---|---|
| height | number | - | Fixed height of the grid in pixels. |
| rowHeight | number | 40 | Fixed height for each row in pixels. |
| density | 'sm' | 'md' | 'lg' | 'md' | Controls vertical padding and spacing within rows. |
Features Props
| Name | Type | Default | Description |
|---|---|---|---|
| selectable | boolean | false | Enables row selection with checkboxes. |
| sortable | boolean | false | Global toggle for column sorting. |
| filterable | boolean | false | Global toggle for column header filtering. |
| groupable | boolean | false | Global toggle for row grouping features. |
| virtualized | boolean | true | Enables vertical virtualization for high performance. |
| showToolbar | boolean | true | Toggles visibility of the top action toolbar. |
Pagination Props
| Name | Type | Default | Description |
|---|---|---|---|
| pagination | PaginationOptions | - | Configuration for client or server-side pagination. |
Events Props
| Name | Type | Default | Description |
|---|---|---|---|
| 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.