Column Resizing Feature Guide
Material React Table lets you easily change the default widths (sizes) of columns and has a built-in column resizing draggable handle feature.
Upgrade to MRT v1.7.0 for big column resizing performance improvements!
Relevant Props
# | Prop Name | Type | Default Value | More Info Links | |
---|---|---|---|---|---|
1 |
|
| MRT Column Resizing Docs | ||
2 |
| TanStack Table Core Table Docs | |||
3 |
| MRT Column Resizing Docs | |||
4 |
| TanStack Table Column Sizing Docs | |||
5 |
| TanStack Table Column Sizing Docs | |||
Relevant Column Options
Relevant State
# | State Option | Type | Default Value | More Info Links | |
---|---|---|---|---|---|
1 |
|
| TanStack Table Column Sizing Docs | ||
2 |
|
| TanStack Table Column Sizing Docs | ||
Change Default Column Widths
Column Size
This was also covered in the Data Columns Guide, but we'll cover it again here.
You can change the width of any column by setting its size
option on the column definition. minSize
and maxSize
are also available to enforce limits during resizing.
const columns = [{accessorKey: 'id',header: 'ID',size: 50, //small column},{accessorKey: 'username',header: 'Username',minSize: 100, //min size enforced during resizingmaxSize: 400, //max size enforced during resizingsize: 180, //medium column},{accessorKey: 'email',header: 'Email',size: 300, //large column},];
You may notice, however, that the column sizes might not change as much as you would expect. This is because the browser treats <th>
and <td>
elements differently with in a <table>
element by default.
You can improve this slightly by changing the table layout to "fixed"
instead of the default "auto"
in the muiTableProps
. Though note that this only works if you are using the default "semantic"
layout mode (and no virtualization features).
<MaterialReactTablemuiTableProps={{sx: {tableLayout: 'fixed',},}}/>
The columns will still try to increase their width to take up the full width of the table, but the columns that do have a defined size will have their width respected more.
For further reading on how table-layout fixed
vs auto
works, we recommend reading this blog post by CSS-Tricks.
If you are using either virtualization features or have the layoutMode set to "grid"
, another option is to turn off flex grow for both the table head and body cells. You can see this down below at the bottom of this page
Default Column
By default, columns will have the following size properties defined:
defaultColumn = { minSize: 40, maxSize: 1000, size: 180 }; //units are in px
You can modify the default column widths by setting the defaultColumn
prop on the table.
<MaterialReactTablecolumns={columns}data={data}defaultColumn={{minSize: 20, //allow columns to get smaller than defaultmaxSize: 9001, //allow columns to get larger than defaultsize: 260, //make columns wider by default}}/>
Enable Column Resizing Feature
enableColumnResizing
is the boolean prop that enables the column resizing feature.
<MaterialReactTable columns={columns} data={data} enableColumnResizing />
You can disable specific columns from being resizable by setting the enableResizing
column option to false in their respective column definition.
When Column Resizing is enabled and the layoutMode is still set to the default
"semantic"
value, a CSStable-layout: fixed
style is automatically added to the<table>
element in order to make the browser respect the widths of the columns more.
Column Resize Mode
The default columnResizeMode was changed to
"onChange"
in v1.7.0 instead of"onEnd"
because most of the column resizing performance issues were fixed.
The default columnResizeMode
is onChange
(in MRT versions v1.7+), which means that the column resizing will occur immediately as the user drags the column resize handle. If you are running into performance issues because of many other enabled features, you might want to set the columnResizeMode
to onEnd
instead. This will make the column resizing only occur after the user has finished dragging the column resize handle and released their mouse.
<MaterialReactTablecolumns={columns}data={data}enableColumnResizingcolumnResizeMode="onEnd" //instead of the default "onChange" mode/>
First Name | Last Name | Email Address | City | Country |
---|---|---|---|---|
Dylan | Murray | dmurray@yopmail.com | East Daphne | USA |
Raquel | Kohler | rkholer33@yopmail.com | Columbus | USA |
Ervin | Reinger | ereinger@mailinator.com | Toronto | Canada |
Brittany | McCullough | bmccullough44@mailinator.com | Lincoln | USA |
Branson | Frami | bframi@yopmain.com | New York | USA |
1import React, { useMemo } from 'react';2import MaterialReactTable, { MRT_ColumnDef } from 'material-react-table';3import { data, Person } from './makeData';45const Example = () => {6 const columns = useMemo<MRT_ColumnDef<Person>[]>(7 () => [8 {9 accessorKey: 'firstName',10 header: 'First Name', //uses the default width from defaultColumn prop11 },12 {13 accessorKey: 'lastName',14 header: 'Last Name',15 enableResizing: false, //disable resizing for this column16 },17 {18 accessorKey: 'email',19 header: 'Email Address',20 size: 200, //increase the width of this column21 },22 {23 accessorKey: 'city',24 header: 'City',25 size: 120, //decrease the width of this column26 },27 {28 accessorKey: 'country',29 header: 'Country',30 size: 100, //decrease the width of this column31 },32 ],33 [],34 );3536 return (37 <MaterialReactTable38 columns={columns}39 data={data}40 //optionally override the default column widths41 defaultColumn={{42 maxSize: 400,43 minSize: 80,44 size: 150, //default size is usually 18045 }}46 enableColumnResizing47 columnResizeMode="onChange" //default48 />49 );50};5152export default Example;53
Disable Column Growing
New in v1.7
If you want to prevent the columns from growing to fill the width of the table, use this flexbox trick when the layoutMode is "grid"
:
<MaterialReactTablecolumns={columns}data={data}enableColumnResizinglayoutMode="grid" //instead of the default "semantic" layout modemuiTableHeadCellProps={{sx: {flex: '0 0 auto',},}}muiTableBodyCellProps={{sx: {flex: '0 0 auto',},}}/>
First Name | Last Name | Email Address |
---|---|---|
Dylan | Murray | dmurray@yopmail.com |
Raquel | Kohler | rkholer33@yopmail.com |
Ervin | Reinger | ereinger@mailinator.com |
Brittany | McCullough | bmccullough44@mailinator.com |
Branson | Frami | bframi@yopmain.com |
1import React, { useMemo } from 'react';2import MaterialReactTable, { MRT_ColumnDef } from 'material-react-table';3import { data, Person } from './makeData';45const Example = () => {6 const columns = useMemo<MRT_ColumnDef<Person>[]>(7 () => [8 {9 accessorKey: 'firstName',10 header: 'First Name',11 },12 {13 accessorKey: 'lastName',14 header: 'Last Name',15 },16 {17 accessorKey: 'email',18 header: 'Email Address',19 size: 300,20 },21 ],22 [],23 );2425 return (26 <MaterialReactTable27 columns={columns}28 data={data}29 enableColumnResizing30 layoutMode="grid"31 //Disables the default flex-grow behavior of the table cells32 muiTableHeadCellProps={{33 sx: {34 flex: '0 0 auto',35 },36 }}37 muiTableBodyCellProps={{38 sx: {39 flex: '0 0 auto',40 },41 }}42 //43 />44 );45};4647export default Example;48
View Extra Storybook Examples