DataGridPro API
API reference docs for the React DataGridPro component. Learn about the props, CSS, and other APIs of this exported module.
Component demos
Import
import { DataGridPro } from '@mui/x-data-grid-pro/DataGridPro';
// or
import { DataGridPro } from '@mui/x-data-grid-pro';
// or
import { DataGridPro } from '@mui/x-data-grid-premium';The ref object that allows grid manipulation. Can be instantiated with useGridApiRef().
Type:{ current: object }
If true, the pageSize is calculated according to the container size and the max number of rows to avoid rendering a vertical scroll bar.
Type:bool
The options for autosize when user-initiated.
Type:{ columns?: Array<string>, expand?: bool, includeHeaders?: bool, includeOutliers?: bool, outliersFactor?: number }
If true, the grid get a first column with a checkbox that allows to select rows.
Type:bool
If true, the "Select All" header checkbox selects only the rows on the current page. To be used in combination with checkboxSelection. It only works if the pagination is enabled.
Type:bool
Default:false
Override or extend the styles applied to the component.
See CSS API below for more details.
Type:object
The character used to separate cell values when copying to the clipboard.
Type:string
Default:'\t'
Number of extra columns to be rendered before/after the visible slice.
Type:number
Default:3
Number of rows from the columnBuffer that can be visible before a new slice is rendered.
Type:number
Default:3
Set the column visibility model of the grid. If defined, the grid will ignore the hide property in GridColDef.
Type:object
If above 0, the row children will be expanded up to this depth. If equal to -1, all the row children will be expanded.
Type:number
Default:0
If true, the filtering will only be applied to the top level rows when grouping rows with the treeData prop.
Type:bool
If true, the sorting will only be applied to the top level rows when grouping rows with the treeData prop.
Type:bool
If true, multiple selection using the Ctrl or CMD key is disabled.
Type:bool
Unstable features, breaking changes might be introduced. For each feature, if the flag is not explicitly set to true, the feature will be fully disabled and any property / method call will not have any effect.
Type:{ ariaV7?: bool, columnGrouping?: bool, lazyLoading?: bool, warnIfFocusStateIsNotSynced?: bool }
The milliseconds delay to wait after a keystroke before triggering filtering.
Type:number
Default:150
Filtering can be processed on the server or client-side. Set it to 'server' if you would like to handle filtering on the server-side.
Type:'client'
| 'server'
Default:"client"
Set the filter model of the grid.
Type:{ items: Array<{ field: string, id?: number
| string, operator: string, value?: any }>, logicOperator?: 'and'
| 'or', quickFilterExcludeHiddenColumns?: bool, quickFilterLogicOperator?: 'and'
| 'or', quickFilterValues?: array }
Function that applies CSS classes dynamically on cells.
Type:func
function(params: GridCellParams) => stringparamsWith all properties from GridCellParams.
Returns: The CSS class to apply to the cell.
Function that returns the element to render in row detail.
Type:func
function(params: GridRowParams) => React.JSX.ElementparamsWith all properties from GridRowParams.
Returns: The row detail element.
Function that returns the height of the row detail panel.
Type:func
Default:"() => 500"
function(params: GridRowParams) => number | stringparamsWith all properties from GridRowParams.
Returns: The height in pixels or "auto" to use the content height.
Function that returns the estimated height for a row. Only works if dynamic row height is used. Once the row height is measured this value is discarded.
Type:func
function(params: GridRowHeightParams) => number | nullparamsWith all properties from GridRowHeightParams.
Returns: The estimated row height value. If null or undefined then the default row height, based on the density, is applied.
Function that applies CSS classes dynamically on rows.
Type:func
function(params: GridRowClassNameParams) => stringparamsWith all properties from GridRowClassNameParams.
Returns: The CSS class to apply to the row.
Function that sets the row height per row.
Type:func
function(params: GridRowHeightParams) => GridRowHeightReturnValueparamsWith all properties from GridRowHeightParams.
Returns: The row height value. If null or undefined then the default row height is applied. If "auto" then the row height is calculated based on the content.
Function that allows to specify the spacing between rows.
Type:func
function(params: GridRowSpacingParams) => GridRowSpacingparamsWith all properties from GridRowSpacingParams.
Returns: The row spacing values.
Determines the path of a row in the tree data. For instance, a row with the path ["A", "B"] is the child of the row with the path ["A"]. Note that all paths must contain at least one element.
Type:func
function(row: R) => ArrayrowThe row from which we want the path.
Returns: The path to the row.
If true, the diacritics (accents) are ignored when filtering or quick filtering. E.g. when filter value is cafe, the rows with café will be visible.
Type:bool
If true, the grid will not use valueFormatter when exporting to CSV or copying to clipboard. If an object is provided, you can choose to ignore the valueFormatter for CSV export or clipboard export.
Type:{ clipboardExport?: bool, csvExport?: bool }
| bool
Default:false
The initial state of the DataGridPro. The data in it will be set in the state on initialization but will not be controlled. If one of the data in initialState is also being controlled, then the control state wins.
Type:object
Callback fired when a cell is rendered, returns true if the cell is editable.
Type:func
function(params: GridCellParams) => booleanparamsWith all properties from GridCellParams.
Returns: A boolean indicating if the cell is editable.
Determines if a group should be expanded after its creation. This prop takes priority over the defaultGroupingExpansionDepth prop.
Type:func
function(node: GridGroupNode) => booleannodeThe node of the group to test.
Returns: A boolean indicating if the group is expanded.
Determines if a row can be selected.
Type:func
function(params: GridRowParams) => booleanparamsWith all properties from GridRowParams.
Returns: A boolean indicating if the cell is selectable.
If true, moving the mouse pointer outside the grid before releasing the mouse button in a column re-order action will not cause the column to jump back to its original position.
Type:bool
If true, the selection model will retain selected rows that do not exist. Useful when using server side pagination and row selections need to be retained when changing pages.
Type:bool
Set the locale text of the grid. You can find all the translation keys supported in the source in the GitHub repository.
Type:object
Pass a custom logger in the components that implements the Logger interface.
Type:{ debug: func, error: func, info: func, warn: func }
Default:console
Allows to pass the logging level or false to turn off logging.
Type:'debug'
| 'error'
| 'info'
| 'warn'
| false
Default:"error" ("warn" in dev mode)
Callback fired when any cell is clicked.
Type:func
function(params: GridCellParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridCellParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when a double click event comes from a cell element.
Type:func
function(params: GridCellParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridCellParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when the cell turns to edit mode.
Type:func
function(params: GridCellParams, event: MuiEvent) => void paramsWith all properties from GridCellParams.eventThe event that caused this prop to be called.
Callback fired when the cell turns to view mode.
Type:func
function(params: GridCellParams, event: MuiEvent) => void paramsWith all properties from GridCellParams.eventThe event that caused this prop to be called.
Callback fired when a keydown event comes from a cell element.
Type:func
function(params: GridCellParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridCellParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when the cellModesModel prop changes.
Type:func
function(cellModesModel: GridCellModesModel, details: GridCallbackDetails) => voidcellModesModelObject containing which cells are in "edit" mode.detailsAdditional details for this callback.
Callback called when the data is copied to the clipboard.
Type:func
function(data: string) => voiddataThe data copied to the clipboard.
Callback fired when a click event comes from a column header element.
Type:func
function(params: GridColumnHeaderParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridColumnHeaderParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when a double click event comes from a column header element.
Type:func
function(params: GridColumnHeaderParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridColumnHeaderParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when a mouse enter event comes from a column header element.
Type:func
function(params: GridColumnHeaderParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridColumnHeaderParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when a mouse leave event comes from a column header element.
Type:func
function(params: GridColumnHeaderParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridColumnHeaderParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when a mouseout event comes from a column header element.
Type:func
function(params: GridColumnHeaderParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridColumnHeaderParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when a mouseover event comes from a column header element.
Type:func
function(params: GridColumnHeaderParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridColumnHeaderParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when a column is reordered.
Type:func
function(params: GridColumnOrderChangeParams, event: MuiEvent<{}>, details: GridCallbackDetails) => voidparamsWith all properties from GridColumnOrderChangeParams.eventThe event object.detailsAdditional details for this callback.
Callback fired while a column is being resized.
Type:func
function(params: GridColumnResizeParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridColumnResizeParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when the column visibility model changes.
Type:func
function(model: GridColumnVisibilityModel, details: GridCallbackDetails) => voidmodelThe new model.detailsAdditional details for this callback.
Callback fired when the width of a column is changed.
Type:func
function(params: GridColumnResizeParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridColumnResizeParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when the detail panel of a row is opened or closed.
Type:func
function(ids: Array, details: GridCallbackDetails) => void idsThe ids of the rows which have the detail panel open.detailsAdditional details for this callback.
Callback fired when rowCount is set and the next batch of virtualized rows is rendered.
Type:func
function(params: GridFetchRowsParams, event: MuiEvent<{}>, details: GridCallbackDetails) => voidparamsWith all properties from GridFetchRowsParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when the Filter model changes before the filters are applied.
Type:func
function(model: GridFilterModel, details: GridCallbackDetails) => voidmodelWith all properties from GridFilterModel.detailsAdditional details for this callback.
Callback fired when the menu is closed.
Type:func
function(params: GridMenuParams, event: MuiEvent<{}>, details: GridCallbackDetails) => voidparamsWith all properties from GridMenuParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when the menu is opened.
Type:func
function(params: GridMenuParams, event: MuiEvent<{}>, details: GridCallbackDetails) => voidparamsWith all properties from GridMenuParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when the pagination model has changed.
Type:func
function(model: GridPaginationModel, details: GridCallbackDetails) => voidmodelUpdated pagination model.detailsAdditional details for this callback.
Callback fired when the pinned columns have changed.
Type:func
function(pinnedColumns: GridPinnedColumns, details: GridCallbackDetails) => voidpinnedColumnsThe changed pinned columns.detailsAdditional details for this callback.
Callback fired when the preferences panel is closed.
Type:func
function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => voidparamsWith all properties from GridPreferencePanelParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when the preferences panel is opened.
Type:func
function(params: GridPreferencePanelParams, event: MuiEvent<{}>, details: GridCallbackDetails) => voidparamsWith all properties from GridPreferencePanelParams.eventThe event object.detailsAdditional details for this callback.
Callback called when processRowUpdate throws an error or rejects.
Type:func
function(error: any) => voiderrorThe error thrown.
Callback fired when the grid is resized.
Type:func
function(containerSize: ElementSize, event: MuiEvent<{}>, details: GridCallbackDetails) => voidcontainerSizeWith all properties from ElementSize.eventThe event object.detailsAdditional details for this callback.
Callback fired when a row is clicked. Not called if the target clicked is an interactive element added by the built-in columns.
Type:func
function(params: GridRowParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from GridRowParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when a double click event comes from a row container element.
Type:func
function(params: GridRowParams, event: MuiEvent, details: GridCallbackDetails) => void paramsWith all properties from RowParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when the row changes are committed.
Type:func
function(id: GridRowId, event: MuiEvent) => void idThe row id.eventThe event that caused this prop to be called.
Callback fired when the row turns to edit mode.
Type:func
function(params: GridRowParams, event: MuiEvent) => void paramsWith all properties from GridRowParams.eventThe event that caused this prop to be called.
Callback fired when the row turns to view mode.
Type:func
function(params: GridRowParams, event: MuiEvent) => void paramsWith all properties from GridRowParams.eventThe event that caused this prop to be called.
Callback fired when the rowModesModel prop changes.
Type:func
function(rowModesModel: GridRowModesModel, details: GridCallbackDetails) => voidrowModesModelObject containing which rows are in "edit" mode.detailsAdditional details for this callback.
Callback fired when a row is being reordered.
Type:func
function(params: GridRowOrderChangeParams, event: MuiEvent<{}>, details: GridCallbackDetails) => voidparamsWith all properties from GridRowOrderChangeParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when the selection state of one or multiple rows changes.
Type:func
function(rowSelectionModel: GridRowSelectionModel, details: GridCallbackDetails) => voidrowSelectionModelWith all the row ids GridSelectionModel.detailsAdditional details for this callback.
Callback fired when scrolling to the bottom of the grid viewport.
Type:func
function(params: GridRowScrollEndParams, event: MuiEvent<{}>, details: GridCallbackDetails) => voidparamsWith all properties from GridRowScrollEndParams.eventThe event object.detailsAdditional details for this callback.
Callback fired when the sort model changes before a column is sorted.
Type:func
function(model: GridSortModel, details: GridCallbackDetails) => voidmodelWith all properties from GridSortModel.detailsAdditional details for this callback.
Select the pageSize dynamically using the component UI.
Type:Array<number
| { label: string, value: number }>
Default:[25, 50, 100]
Pagination can be processed on the server or client-side. Set it to 'client' if you would like to handle the pagination on the client-side. Set it to 'server' if you would like to handle the pagination on the server-side.
Type:'client'
| 'server'
Default:"client"
The pagination model of type GridPaginationModel which refers to current page and pageSize.
Type:{ page: number, pageSize: number }
The column fields to display pinned to left or right.
Type:{ left?: Array<string>, right?: Array<string> }
Callback called before updating a row with new values in the row and cell editing.
Type:func
function(newRow: R, oldRow: R) => Promise | R newRowRow object with the new values.oldRowRow object with the old values.
Returns: The final values to update the row.
Set the total number of rows, if it is different from the length of the value rows prop. If some rows have children (for instance in the tree data), this number represents the amount of top level rows.
Type:number
The milliseconds delay to wait after measuring the row height before recalculating row positions. Setting it to a lower value could be useful when using dynamic row height, but might reduce performance when displaying a large number of rows.
Type:number
Default:166
Sets the row selection model of the grid.
Type:Array<number
| string>
| number
| string
Loading rows can be processed on the server or client-side. Set it to 'client' if you would like enable infnite loading. Set it to 'server' if you would like to enable lazy loading. * @default "client"
Type:'client'
| 'server'
Sets the type of space between rows added by getRowSpacing.
Type:'border'
| 'margin'
Default:"margin"
Number of rows from the rowBuffer that can be visible before a new slice is rendered.
Type:number
Default:3
Set the area in px at the bottom of the grid viewport where onRowsScrollEnd is called.
Type:number
Default:80
Sorting can be processed on the server or client-side. Set it to 'client' if you would like to handle sorting on the client-side. Set it to 'server' if you would like to handle sorting on the server-side.
Type:'client'
| 'server'
Default:"client"
The order of the sorting sequence.
Type:Array<'asc'
| 'desc'>
Default:['asc', 'desc', null]
The system prop that allows defining system overrides as well as additional CSS styles.
See the `sx` page for more details.
Type:Array<func
| object
| bool>
| func
| object
If positive, the Grid will throttle updates coming from apiRef.current.updateRows and apiRef.current.setRows. It can be useful if you have a high update rate but do not want to do heavy work like filtering / sorting or rendering on each individual update.
Type:number
Default:0
ref is forwarded to the root element.The following class names are useful for styling with CSS (the state classes are marked).
To learn more, visit the component customization page.
Styles applied to the root element of the cell with type="actions".
Rule name:actionsCell
Styles applied to the root element of the column header when aggregated.
Rule name:aggregationColumnHeader
Styles applied to the root element of the header when aggregation if headerAlign="left".
Rule name:aggregationColumnHeader--alignLeft
Styles applied to the root element of the header when aggregation if headerAlign="center".
Rule name:aggregationColumnHeader--alignCenter
Styles applied to the root element of the header when aggregation if headerAlign="right".
Rule name:aggregationColumnHeader--alignRight
Styles applied to the aggregation label in the column header when aggregated.
Rule name:aggregationColumnHeaderLabel
Styles applied to the root element while it is being autosized.
Rule name:autosizing
Styles applied to the cell element if the cell is editable.
Rule name:cell--editable
Styles applied to the cell element if the cell is in edit mode.
Rule name:cell--editing
Styles applied to the cell element if align="center".
Rule name:cell--textCenter
Styles applied to the cell element if align="left".
Rule name:cell--textLeft
Styles applied to the cell element if align="right".
Rule name:cell--textRight
Styles applied to the cell element if the cell has a custom renderer.
Rule name:cell--withRenderer
Styles applied to the cell element if it is at the top edge of a cell selection range.
Rule name:cell--rangeTop
Styles applied to the cell element if it is at the bottom edge of a cell selection range.
Rule name:cell--rangeBottom
Styles applied to the cell element if it is at the left edge of a cell selection range.
Rule name:cell--rangeLeft
Styles applied to the cell element if it is at the right edge of a cell selection range.
Rule name:cell--rangeRight
Styles applied to the cell element if it is in a cell selection range.
Rule name:cell--selectionMode
Styles applied to the element that wraps the cell content.
Rule name:cellContent
Styles applied to the column header if headerAlign="center".
Rule name:columnHeader--alignCenter
Styles applied to the column header if headerAlign="left".
Rule name:columnHeader--alignLeft
Styles applied to the column header if headerAlign="right".
Rule name:columnHeader--alignRight
Styles applied to the floating column header element when it is dragged.
Rule name:columnHeader--dragging
Styles applied to the column header if it is being dragged.
Rule name:columnHeader--moving
Styles applied to the column header if the type of the column is number.
Rule name:columnHeader--numeric
Styles applied to the column header if the column is sortable.
Rule name:columnHeader--sortable
Styles applied to the column header if the column is sorted.
Rule name:columnHeader--sorted
Styles applied to the column header if the column has a filter applied to it.
Rule name:columnHeader--filtered
Styles applied to the column group header element.
Rule name:columnGroupHeader
Styles applied to the header checkbox cell element.
Rule name:columnHeaderCheckbox
Styles applied to the column header's draggable container element.
Rule name:columnHeaderDraggableContainer
Styles applied to the row's draggable placeholder element inside the special row reorder cell.
Rule name:rowReorderCellPlaceholder
Styles applied to the column headers wrapper if a column is being dragged.
Rule name:columnHeaderDropZone
Styles applied to the column header's title element;
Rule name:columnHeaderTitle
Styles applied to the column header's title container element.
Rule name:columnHeaderTitleContainer
Styles applied to the column header's title excepted buttons.
Rule name:columnHeaderTitleContainerContent
Styles applied to the column group header cell if not empty.
Rule name:columnHeader--filledGroup
Styles applied to the empty column group header cell.
Rule name:columnHeader--emptyGroup
Styles applied to the column group header cell when show column border.
Rule name:columnHeader--showColumnBorder
Styles applied to the column headers's inner element.
Rule name:columnHeadersInner
Styles applied to the column headers's inner element if there is a horizontal scrollbar.
Rule name:columnHeadersInner--scrollable
Styles applied to the column header separator if the column is resizable.
Rule name:columnSeparator--resizable
Styles applied to the column header separator if the column is being resized.
Rule name:columnSeparator--resizing
Styles applied to the column header separator if the side is "left".
Rule name:columnSeparator--sideLeft
Styles applied to the column header separator if the side is "right".
Rule name:columnSeparator--sideRight
Styles applied to the column header separator element.
Rule name:columnSeparator
Styles applied to the columns panel row element.
Rule name:columnsPanelRow
Styles applied to the detail panel toggle cell element.
Rule name:detailPanelToggleCell
Styles applied to the detail panel toggle cell element if expanded.
Rule name:detailPanelToggleCell--expanded
Styles applied to root of the boolean edit component.
Rule name:editBooleanCell
Styles applied to the delete icon of the filter form component.
Rule name:filterFormDeleteIcon
Styles applied to the link operator input of the filter form component.
Rule name:filterFormLogicOperatorInput
Styles applied to the column input of the filter form component.
Rule name:filterFormColumnInput
Styles applied to the operator input of the filter form component.
Rule name:filterFormOperatorInput
Styles applied to the value input of the filter form component.
Rule name:filterFormValueInput
Styles applied to the column header icon's container.
Rule name:iconButtonContainer
Styles applied to the column header separator icon element.
Rule name:iconSeparator
Styles applied to the column header filter row.
Rule name:headerFilterRow
Styles applied to the overlay wrapper inner element.
Rule name:overlayWrapperInner
Styles applied to the virtualization container.
Rule name:virtualScroller
Styles applied to the virtualization content.
Rule name:virtualScrollerContent
Styles applied to the virtualization content when its height is bigger than the virtualization container.
Rule name:virtualScrollerContent--overflowed
Styles applied to the virtualization render zone.
Rule name:virtualScrollerRenderZone
Styles applied to the left pinned columns.
Rule name:pinnedColumns--left
Styles applied to the right pinned columns.
Rule name:pinnedColumns--right
Styles applied to the pinned column headers.
Rule name:pinnedColumnHeaders
Styles applied to the left pinned column headers.
Rule name:pinnedColumnHeaders--left
Styles applied to the right pinned column headers.
Rule name:pinnedColumnHeaders--right
Styles applied to the root element if density is "standard" (default).
Rule name:root--densityStandard
Styles applied to the root element if density is "comfortable".
Rule name:root--densityComfortable
Styles applied to the root element if density is "compact".
Rule name:root--densityCompact
Styles applied to the root element when user selection is disabled.
Rule name:root--disableUserSelection
Styles applied to the row element if the row is editable.
Rule name:row--editable
Styles applied to the row element if the row is in edit mode.
Rule name:row--editing
Styles applied to the floating special row reorder cell element when it is dragged.
Rule name:row--dragging
Styles applied to the last visible row element on every page of the grid.
Rule name:row--lastVisible
Styles applied to the row if it has dynamic row height.
Rule name:row--dynamicHeight
Styles applied to the row if its detail panel is open.
Rule name:row--detailPanelExpanded
Styles applied to the footer row count element to show the total number of rows. Only works when pagination is disabled.
Rule name:rowCount
Styles applied to the row reorder cell container element.
Rule name:rowReorderCellContainer
Styles applied to the root element of the row reorder cell
Rule name:rowReorderCell
Styles applied to the root element of the row reorder cell when dragging is allowed
Rule name:rowReorderCell--draggable
Styles applied to the left scroll area element.
Rule name:scrollArea--left
Styles applied to the right scroll area element.
Rule name:scrollArea--right
Styles applied to the footer selected row count element.
Rule name:selectedRowCount
Styles applied to the toolbar container element.
Rule name:toolbarContainer
Styles applied to the toolbar filter list element.
Rule name:toolbarFilterList
Styles applied to cells, column header and other elements that have border. Sets border color only.
Rule name:withBorderColor
Styles applied the cell if `showColumnVerticalBorder={true}`.
Rule name:cell--withRightBorder
Styles applied the column header if `showColumnVerticalBorder={true}`.
Rule name:columnHeader--withRightBorder
Styles applied to the root of the grouping column of the tree data.
Rule name:treeDataGroupingCell
Styles applied to the toggle of the grouping cell of the tree data.
Rule name:treeDataGroupingCellToggle
Styles applied to the root element of the grouping criteria cell
Rule name:groupingCriteriaCell
Styles applied to the toggle of the grouping criteria cell
Rule name:groupingCriteriaCellToggle
Styles applied to the top pinned rows container.
Rule name:pinnedRows--top
Styles applied to the bottom pinned rows container.
Rule name:pinnedRows--bottom
You can override the style of the component using one of these customization options:
- With a global class name.
- With a rule name as part of the component's
styleOverridesproperty in a custom theme.
The custom Checkbox component used in the grid for both header and cells.
Default: Checkbox
Icon displayed on the boolean cell to represent the false value.
Default: GridCloseIcon
Icon displayed on the boolean cell to represent the true value.
Default: GridCheckIcon
Icon displayed on the column header menu to show that a filter has been applied to the column.
Default: GridFilterAltIcon
Filter icon component rendered in each column header.
Default: GridColumnHeaderFilterIconButton
Column menu component rendered by clicking on the 3 dots "kebab" icon in column headers.
Default: GridColumnMenu
Icon displayed on the side of the column header title to display the filter input component.
Default: GridTripleDotsVerticalIcon
Icon displayed in column menu for showing all columns
Default: GridViewColumnIcon
Icon displayed in column menu for ascending sort
Default: GridArrowUpwardIcon
Icon displayed in column menu for descending sort
Default: GridArrowDownwardIcon
Icon displayed in between two column headers that allows to resize the column header.
Default: GridSeparatorIcon
Icon displayed on the side of the column header title when sorted in ascending order.
Default: GridArrowUpwardIcon
Icon displayed on the side of the column header title when sorted in descending order.
Default: GridArrowDownwardIcon
Icon displayed on the side of the column header title when unsorted.
Default: GridColumnUnsortedIcon
GridColumns panel component rendered when clicking the columns button.
Default: GridColumnsPanel
Icon displayed on the "comfortable" density option in the toolbar.
Default: GridViewStreamIcon
Icon displayed on the compact density option in the toolbar.
Default: GridViewHeadlineIcon
Icon displayed on the standard density option in the toolbar.
Default: GridTableRowsIcon
Icon displayed on the detail panel toggle column when expanded.
Default: GridRemoveIcon
Icon displayed on the detail panel toggle column when collapsed.
Default: GridAddIcon
Icon displayed on the open export button present in the toolbar by default.
Default: GridSaveAltIcon
Icon displayed for deleting the filter from filter panel.
Default: GridDeleteIcon
Icon displayed for deleting all the active filters from filter panel.
Default: GridDeleteForeverIcon
Icon displayed on the grouping column when the children are expanded
Default: GridExpandMoreIcon
Icon displayed on the grouping column when the children are collapsed
Default: GridKeyboardArrowRight
Component responsible for showing menu adornment in Header filter row
Default: GridHeaderFilterCell
Component responsible for showing menu in Header filter row
Default: GridHeaderFilterMenu
Loading overlay component rendered when the grid is in a loading state.
Default: GridLoadingOverlay
No results overlay component rendered when the grid has no results after filtering.
Default: GridNoResultsOverlay
No rows overlay component rendered when the grid has no rows.
Default: GridNoRowsOverlay
Icon displayed on the open filter button present in the toolbar by default.
Default: GridFilterListIcon
Icon displayed on the tree data toggling column when the children are expanded
Default: GridExpandMoreIcon