Data Grid - Styling
The grid CSS can be easily overwritten.
Using the sx
prop
For one-off styles, the sx
prop can be used.
It allows to apply simple to complex customizations directly onto the DataGrid
element.
The keys accepted can be any CSS property as well as the custom properties provided by MUI.
For more details, visit the sx
prop page.
<DataGrid sx={{ m: 2 }} /> // Sets the margin to 2 times the spacing unit = 16px
Styling column headers
The GridColDef
type has properties to apply class names and custom CSS on the header.
headerClassName
: to apply class names into the column header. It can also be a function, which is called with aGridColumnHeaderParams
object.headerAlign
: to align the content of the header. It must be 'left' | 'right' | 'center'.
const columns: GridColDef[] = [
{
field: 'first',
headerClassName: 'super-app-theme--header',
headerAlign: 'center',
},
{
field: 'last',
headerClassName: 'super-app-theme--header',
headerAlign: 'center',
},
];
Styling rows
The getRowClassName
prop can be used to apply a custom CSS class on each row. It's called with a GridRowParams
object and must return a string. Sometimes it might be needed to override the existing rules using higher specificity CSS selectors.
interface GridRowParams<R extends GridRowModel = GridRowModel> {
/**
* The grid row id.
*/
id: GridRowId;
/**
* The row model of the row that the current cell belongs to.
*/
row: R;
/**
* All grid columns.
*/
columns: GridColDef[];
}
Styling cells
There are multiple ways to apply a custom CSS class on a cell.
- Using the
cellClassName
property ofGridColDef
:
This property allows to set a CSS class that is applied on every cell of the column it was defined.
It can also be a function, which is called with a GridCellParams
object.
const columns: GridColDef[] = [
{
field: 'name',
cellClassName: 'super-app-theme--cell',
},
{
field: 'score',
type: 'number',
cellClassName: (params: GridCellParams<number>) =>
clsx('super-app', {
negative: params.value < 0,
positive: params.value > 0,
}),
},
];
- Using the
getCellClassName
prop:
This prop is called for every cell in every column.
Different from the first option, this prop is defined at the grid level, not column level.
It is also called with a GridCellParams
object.
Cell alignment
Use the align
property in GridColDef
to change the alignment of content of the cells.
Choose between one of the following values: 'left' | 'right' | 'center'.
Striped rows
You can use the indexRelativeToCurrentPage
param passed to getRowClassName
to apply alternating styles to the rows.
The following demo illustrates how this can be achieved.
Custom theme
The following demo leverages the CSS customization API to match the Ant Design specification.