MRT logoMaterial React Table

Legacy V1 Docs
On This Page

    Density Toggle Feature Guide

    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.

    Relevant Props

    MRT Density Toggle Docs
    MRT Density Toggle Docs

    Relevant State

    'comfortable' | 'compact' | 'spacious'

    Default Density

    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.

    Change Default Density

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

    initialState={{ density: 'compact' }}

    Disable or Hide the Density Toggle

    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 prop.


    Open StackblitzOpen Code SandboxOpen on GitHub
    DylanMurray261 Erdman FordEast DaphneKentucky
    RaquelKohler769 Dominic GroveColumbusOhio
    ErvinReinger566 Brakus InletSouth LindaWest Virginia
    BrittanyMcCullough722 Emie StreamLincolnNebraska
    BransonFrami32188 Larkin TurnpikeCharlestonSouth Carolina

    Rows per page

    1-5 of 5

    Source Code

    1import React, { useMemo } from 'react';
    2import { MaterialReactTable, type MRT_ColumnDef } from 'material-react-table';
    3import { data, type Person } from './makeData';
    5const Example = () => {
    6 const columns = useMemo(
    7 //column definitions...
    33 );
    35 return (
    36 <MaterialReactTable
    37 columns={columns}
    38 data={data}
    39 enableDensityToggle={false}
    40 initialState={{ density: 'compact' }}
    41 />
    42 );
    45export default Example;