Material React Table

Material React Table includes a density toggle button in the top toolbar by default that lets you toggle between three different density levels. This is a great feature to include to help with accessibility for different user preferences, but it can also easily be disabled if desired.

boolean

true

OnChangeFn<MRT_DensityState>

'comfortable' | 'compact' | 'spacious'

'comfortable'

By default, Material React Table will render with a medium comfortable density.

A density toggle is shown by default to let a user change the density to cycle through spacious, comfortable, and compact densities.

When a compact density is set, whitespace is set to nowrap by default to keep the rows as short in height as possible. This can be overridden in the muiTableBodyCellProps styles or sx prop.

If you want to change the default density, you can set it in either the initialState table option or the state table option.

const table = useMaterialReactTable({
  data,
  columns,
  initialState: { density: 'compact' },
});

return <MaterialReactTable table={table} />;

You can change the default density and disable the density toggle itself if you want.

In this example, the density toggle is disabled and a compact density is set by default in the initialState table option.

1import { useMemo } from 'react';
2import {
3  MaterialReactTable,
4  useMaterialReactTable,
5  type MRT_ColumnDef,
6} from 'material-react-table';
7import { data, type Person } from './makeData';
8
9const Example = () => {
10  const columns = useMemo(
11    //column definitions...
12    () =>
13      [
14        {
15          accessorKey: 'firstName',
16          header: 'First Name',
17        },
18        {
19          accessorKey: 'lastName',
20          header: 'Last Name',
21        },
22        {
23          accessorKey: 'address',
24          header: 'Address',
25        },
26        {
27          accessorKey: 'city',
28          header: 'City',
29        },
30        {
31          accessorKey: 'state',
32          header: 'State',
33        },
34      ] as MRT_ColumnDef<Person>[],
35    [],
36    
37  );
38
39  const table = useMaterialReactTable({
40    columns,
41    data,
42    enableDensityToggle: false,
43    initialState: { density: 'compact' },
44  });
45
46  return <MaterialReactTable table={table} />;
47};
48
49export default Example;
50