Material React Table

Whether you just want to change the default column order in your table or let columns be reordered by dragging and dropping, Material React Table has a simple API for this.

boolean

false

boolean

OnChangeFn<ColumnOrderState>

OnChangeFn<MRT_Column<TData> | null>

OnChangeFn<MRT_Column<TData> | null>

boolean

boolean

Array<string>

[]

MRT_Column | null

MRT_Column | null

By Default, Material React Table will order the columns in the order they are defined in the columns table option. And Display Columns such as Actions, Selection, Expansion, etc., get added to either the beginning or the end of the table. You can customize all of this by defining your own columnOrder State and passing it either to the initialState or state props.

The Column Order State is an array of string column ids, that come from the ids or accessorKeys that you defined in your column definitions.

const table = useMaterialReactTable({
  data,
  columns,
  enableRowSelection: true,
  initialState: {
    columnOrder: [
      'name',
      'email',
      'phone',
      'city',
      'country',
      'mrt-row-select', //move the built-in selection column to the end of the table
    ],
  },
});

return <MaterialReactTable table={table} />;

If you need to manage the columnOrder state yourself, you can do so in the state table option and onColumnOrderChange callback, but you will also need to initialize the columnOrder state yourself.

const columns = [
  //...
];

//easy shortcut to initialize the columnOrder state as array of column ids
const [columnOrder, setColumnOrder] = useState(
  columns.map((c) => c.accessorKey), //array of column ids
);

const table = useMaterialReactTable({
  data,
  columns,
  enableRowSelection: true,
  state: {
    columnOrder,
  },
  onColumnOrderChange: setColumnOrder,
});

return <MaterialReactTable table={table} />;

Material React Table has a built-in drag and drop feature to reorder columns. This feature is enabled by passing the enableColumnOrdering table option.

The ability for a column to have a drag and drop handle can be specified by setting the enableColumnOrdering option on the column.

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<MRT_ColumnDef<Person>[]>(
11    () => [
12      {
13        accessorKey: 'firstName',
14        header: 'First Name',
15      },
16      //column definitions...
17      {
18        accessorKey: 'lastName',
19        header: 'Last Name',
20      },
21      {
22        accessorKey: 'address',
23        header: 'Address',
24      },
25      {
26        accessorKey: 'city',
27        header: 'City',
28      },
29      
30      {
31        accessorKey: 'state',
32        enableColumnOrdering: false, //disable column ordering for this column,
33        header: 'State',
34      },
35    ],
36    [],
37  );
38
39  const table = useMaterialReactTable({
40    columns,
41    data,
42    enableColumnOrdering: true,
43  });
44
45  return <MaterialReactTable table={table} />;
46};
47
48export default Example;
49

View Extra Storybook Examples