Editing Feature Guide

If your tables need full CRUD functionality, you can enable editing features in Material React Table.

There are four visually distinct editing modes to choose from, whether you want to let users edit data in a modal, inline one row at a time, one cell at a time, or just always have editing enabled for every cell.

Relevant Props

#	Type	Default Value	More Info Links
1	'modal' \| 'cell' \| 'row' \| 'table'	'modal'	MRT Editing Docs

2	boolean \| (row: MRT_Row) => boolean		MRT Editing Docs

3	TextFieldProps \| ({ cell, column, row, table }) => TextFieldProps		Material UI TextField Props

4	OnChangeFn<MRT_Cell<TData> \| null>

5	({ row, table }) => void		MRT Editing Docs

6	OnChangeFn<MRT_Row<TData> \| null>

7	({ exitEditingMode, row, table, values}) => Promise<void> \| void		MRT Editing Docs

Relevant Column Options

#	Type	Default Value	More Info Links
1	Array<string \| { text: string; value: string }>

2	'text' \| 'select'	'text'

3	boolean \| (row) => boolean

4	TextFieldProps \| ({ cell, column, row, table }) => TextFieldProps		Material UI TextField API

Relevant State Options

	#	State Option	Type	Default Value	More Info Links
	1		MRT_Cell

	2		MRT_Row

Enable Editing

To enable editing, you first need to set the enableEditing prop to true.

<MaterialReactTable columns={columns} data={data} enableEditing={true} />

However, this is just the first step. You will need to hook up logic and event listeners, but it depends on which editing mode you want to use.

Editing Modes

Material React Table has four supported editing modes: "modal" (default), "row", "cell" and "table". You can specify which editing mode you want to use by passing the editingMode prop.

The "modal" editing mode opens up a dialog where the user can edit data for one row at a time. No data is saved to the table until the user clicks the save button. Clicking the cancel button clears out any changes that were made on that row.

An onEditingRowSave callback function prop must be provided where you will get access to the updated row data so that changes can be processed and saved. It is up to you how you handle the data. This function has a exitEditingMode parameter that must be called in order to exit editing mode upon save. The reason for this is so that you can perform validation checks before letting the modal close.

The onEditingRowSave callback function prop includes an exitEditingMode parameter that must be called in order to exit editing mode upon save. The reason for this is so that you can perform validation checks before letting the modal close.

Open Stackblitz Open Code Sandbox Open on GitHub

Primary

Secondary

Drop to group by

First Name	Last Name	Address	City	State
Dylan	Murray	261 Erdman Ford	East Daphne	Kentucky
Raquel	Kohler	769 Dominic Grove	Columbus	Ohio
Ervin	Reinger	566 Brakus Inlet	South Linda	West Virginia
Brittany	McCullough	722 Emie Stream	Lincoln	Nebraska
Branson	Frami	32188 Larkin Turnpike	Charleston	South Carolina

1import React, { useMemo, useState } from 'react';
2import MaterialReactTable from 'material-react-table';
3import { data } from './makeData';
4
5const Example = () => {
6  const columns = useMemo(
7    () => [
8      //column definitions...
9      {
10        accessorKey: 'firstName',
11        header: 'First Name',
12      },
13      {
14        accessorKey: 'lastName',
15        header: 'Last Name',
16      },
17
18      {
19        accessorKey: 'address',
20        header: 'Address',
21      },
22      {
23        accessorKey: 'city',
24        header: 'City',
25      },
26
27      {
28        accessorKey: 'state',
29        header: 'State',
30      }, 
31    ],
32    [],
33  );
34
35  const [tableData, setTableData] = useState(() => data);
36
37  const handleSaveRow = async ({ exitEditingMode, row, values }) => {
38    //if using flat data and simple accessorKeys/ids, you can just do a simple assignment here.
39    tableData[row.index] = values;
40    //send/receive api updates here
41    setTableData([...tableData]);
42    exitEditingMode(); //required to exit editing mode
43  };
44
45  return (
46    <MaterialReactTable
47      columns={columns}
48      data={tableData}
49      editingMode="modal" //default
50      enableEditing
51      onEditingRowSave={handleSaveRow}
52    />
53  );
54};
55
56export default Example;
57

Row Editing Mode

The row editing mode is an inline row editing mode. When edit mode is activated, the row shows the edit components in the data cells. No data is saved to the table until the user clicks the save button. Clicking the cancel button clears out any changes that were made on that row.

You must provide an onEditingRowSave callback function prop where you will get access to the updated row data so that changes can be processed and saved. It is up to you how you handle the data. This function has a exitEditingMode parameter that must be called in order to exit editing mode upon save. The reason for this is so that you can perform validation checks before letting the modal close.

The onEditingRowSave callback function prop includes an exitEditingMode parameter that must be called in order to exit editing mode upon save. The reason for this is so that you can perform validation checks before letting the modal close.

Demo

Open Stackblitz Open Code Sandbox Open on GitHub

Primary

Secondary

Drop to group by

First Name	Last Name	Address	City	State
Dylan	Murray	261 Erdman Ford	East Daphne	Kentucky
Raquel	Kohler	769 Dominic Grove	Columbus	Ohio
Ervin	Reinger	566 Brakus Inlet	South Linda	West Virginia
Brittany	McCullough	722 Emie Stream	Lincoln	Nebraska
Branson	Frami	32188 Larkin Turnpike	Charleston	South Carolina

Source Code

1import React, { useMemo, useState } from 'react';
2import MaterialReactTable, {
3  MaterialReactTableProps,
4  MRT_ColumnDef,
5} from 'material-react-table';
6import { data, Person } from './makeData';
7
8const Example = () => {
9  const columns = useMemo<MRT_ColumnDef<Person>[]>(
10    () => [
11      //column definitions...
12      {
13        accessorKey: 'firstName',
14        header: 'First Name',
15      },
16      {
17        accessorKey: 'lastName',
18        header: 'Last Name',
19      },
20
21      {
22        accessorKey: 'address',
23        header: 'Address',
24      },
25      {
26        accessorKey: 'city',
27        header: 'City',
28      },
29
30      {
31        accessorKey: 'state',
32        header: 'State',
33      }, 
34    ],
35    [],
36  );
37
38  const [tableData, setTableData] = useState<Person[]>(() => data);
39
40  const handleSaveRow: MaterialReactTableProps<Person>['onEditingRowSave'] =
41    async ({ exitEditingMode, row, values }) => {
42      //if using flat data and simple accessorKeys/ids, you can just do a simple assignment here.
43      tableData[row.index] = values;
44      //send/receive api updates here
45      setTableData([...tableData]);
46      exitEditingMode(); //required to exit editing mode
47    };
48
49  return (
50    <MaterialReactTable
51      columns={columns}
52      data={tableData}
53      editingMode="row"
54      enableEditing
55      onEditingRowSave={handleSaveRow}
56    />
57  );
58};
59
60export default Example;
61

Cell Editing Mode

The cell editing mode is a bit simpler visually. Uses double-click cells to activate editing mode, but only for that cell.

Then there is a bit of work for you to do to wire up either the onBlur, onChange, etc., events yourself in order to save the table data. This can be done in the muiTableBodyCellEditTextFieldProps prop or column definition option.

Demo

Open Stackblitz Open Code Sandbox Open on GitHub

Primary

Secondary

Drop to group by

First Name	Last Name	Address	City	State
Dylan	Murray	261 Erdman Ford	East Daphne	Kentucky
Raquel	Kohler	769 Dominic Grove	Columbus	Ohio
Ervin	Reinger	566 Brakus Inlet	South Linda	West Virginia
Brittany	McCullough	722 Emie Stream	Lincoln	Nebraska
Branson	Frami	32188 Larkin Turnpike	Charleston	South Carolina

Double-Click a Cell to Edit

Source Code

1import React, { useMemo, useState } from 'react';
2import MaterialReactTable, {
3  MRT_Cell,
4  MRT_ColumnDef,
5} from 'material-react-table';
6import { Typography } from '@mui/material';
7import { data, Person } from './makeData';
8
9const Example = () => {
10  const columns = useMemo<MRT_ColumnDef<Person>[]>(
11    () => [
12      //column definitions...
13      {
14        accessorKey: 'firstName',
15        header: 'First Name',
16      },
17      {
18        accessorKey: 'lastName',
19        header: 'Last Name',
20      },
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    ],
35    [],
36  );
37
38  const [tableData, setTableData] = useState<Person[]>(() => data);
39
40  const handleSaveCell = (cell: MRT_Cell<Person>, value: any) => {
41    //if using flat data and simple accessorKeys/ids, you can just do a simple assignment here
42    tableData[cell.row.index][cell.column.id as keyof Person] = value;
43    //send/receive api updates here
44    setTableData([...tableData]); //re-render with new data
45  };
46
47  return (
48    <MaterialReactTable
49      columns={columns}
50      data={tableData}
51      editingMode="cell"
52      enableEditing
53      muiTableBodyCellEditTextFieldProps={({ cell }) => ({
54        //onBlur is more efficient, but could use onChange instead
55        onBlur: (event) => {
56          handleSaveCell(cell, event.target.value);
57        },
58      })}
59      renderBottomToolbarCustomActions={() => (
60        <Typography sx={{ fontStyle: 'italic', p: '0 1rem' }} variant="body2">
61          Double-Click a Cell to Edit
62        </Typography>
63      )}
64    />
65  );
66};
67
68export default Example;
69

Table Editing Mode

The table editing mode is similar to the cell editing mode, but it simply has all of the data cells in the table become editable all at once.

To save data, you must hook up the onBlur, onChange, etc., events yourself. This can be done in the muiTableBodyCellEditTextFieldProps prop or column definition option.

Demo

Open Stackblitz Open Code Sandbox Open on GitHub

Primary

Secondary

Drop to group by

First Name	Last Name	Address	City	State

Source Code

1import React, { useMemo, useState } from 'react';
2import MaterialReactTable, {
3  MRT_Cell,
4  MRT_ColumnDef,
5} from 'material-react-table';
6import { data, Person } from './makeData';
7
8const Example = () => {
9  const columns = useMemo<MRT_ColumnDef<Person>[]>(
10    () => [
11      //column definitions...
12      {
13        accessorKey: 'firstName',
14        header: 'First Name',
15      },
16      {
17        accessorKey: 'lastName',
18        header: 'Last Name',
19      },
20
21      {
22        accessorKey: 'address',
23        header: 'Address',
24      },
25      {
26        accessorKey: 'city',
27        header: 'City',
28      },
29      {
30        accessorKey: 'state',
31        header: 'State',
32      }, 
33    ],
34    [],
35  );
36
37  const [tableData, setTableData] = useState<Person[]>(() => data);
38
39  const handleSaveCell = (cell: MRT_Cell<Person>, value: any) => {
40    //if using flat data and simple accessorKeys/ids, you can just do a simple assignment here
41    tableData[cell.row.index][cell.column.id as keyof Person] = value;
42    //send/receive api updates here
43    setTableData([...tableData]); //re-render with new data
44  };
45
46  return (
47    <MaterialReactTable
48      columns={columns}
49      data={tableData}
50      editingMode="table"
51      enableEditing
52      muiTableBodyCellEditTextFieldProps={({ cell }) => ({
53        //onBlur is more efficient, but could use onChange instead
54        onBlur: (event) => {
55          handleSaveCell(cell, event.target.value);
56        },
57        variant: 'outlined',
58      })}
59    />
60  );
61};
62
63export default Example;
64

Customizing Editing Components

You can pass any MUI TextField Props with the muiTableBodyCellEditTextFieldProps prop.

const columns = [
  {
    accessor: 'age',
    header: 'Age',
    muiTableBodyCellEditTextFieldProps: {
      required: true,
      type: 'number',
      variant: 'outlined',
    },
  },
];

Add Validation to Editing Components

You can add validation to the editing components by using the muiTableBodyCellEditTextFieldProps events. You can write your validation logic and hook it up to the onBlur, onChange, etc., events, then set the error and helperText props accordingly.

If you are implementing validation, you may also need to use the onEditingRowCancel prop to clear the validation error state.

const [validationErrors, setValidationErrors] = useState({});

const columns = [
  {
    accessor: 'age',
    header: 'Age',
    muiTableBodyCellEditTextFieldProps: {
      error: !!validationErrors.age, //highlight mui text field red error color
      helperText: validationErrors.age, //show error message in helper text.
      required: true,
      type: 'number',
      onChange: (event) => {
        const value = event.target.value;
        //validation logic
        if (!value) {
          setValidationErrors((prev) => ({ ...prev, age: 'Age is required' }));
        } else if (value < 18) {
          setValidationErrors({
            ...validationErrors,
            age: 'Age must be 18 or older',
          });
        } else {
          delete validationErrors.age;
          setValidationErrors({ ...validationErrors });
        }
      },
    },
  },
];

Use Custom Editing Components

If you need to use a much more complicated Editing component than the built-in textfield, you can specify a custom editing component with the Edit column definition option.

const columns = [
  {
    accessorKey: 'email',
    header: 'Email',
    Edit: ({ cell, column, table }) => <Autocomplete />,
  },
];

Customize Actions/Edit Column

You can customize the actions column in a few different ways in the displayColumnDefOptions prop's 'mrt-row-actions' section.

<MaterialReactTable
  data={data}
  columns={columns}
  displayColumnDefOptions={{
    'mrt-row-actions': {
      header: 'Edit', //change "Actions" to "Edit"
      //use a text button instead of a icon button
      Cell: ({ row, table }) => (
        <Button onClick={() => table.setEditingRow(row)}>Edit Customer</Button>
      ),
    },
  }}
/>

React-Hook-Form Example

TODO