Mantine React Table

Display columns are used to display non-data elements in a table. They only require an id and header in the column definition. They do not need an accessorKey or accessorFn, as they are not meant to connect to your data at all.

Display columns do not have any processing features, such as sorting, filtering, grouping, etc. enabled on them by default.

Mantine React Table has a few built-in display columns that are created automatically when certain features are enabled.

• mrt-row-drag - created when enableRowDragging or enableRowOrdering table options are true

• mrt-row-actions - created when enableRowActions (or sometimes when enableEditing) table options are true

• mrt-row-expand - created when enableExpanding, enableGrouping, or renderDetailPanel table options are true

• mrt-row-select - created when enableRowSelection table option is true

• mrt-row-numbers - created when enableRowNumbers table option is true

Display columns are, for the most part, the same as a data column, except they do not have an accessor to access data. When a display column is created internally by Mantine React Table, the following options are all set to false by default:

const defaultDisplayColumnDefOptions = {
  columnDefType: 'display',
  enableClickToCopy: false,
  enableColumnActions: false,
  enableColumnDragging: false,
  enableColumnFilter: false,
  enableColumnOrdering: false,
  enableEditing: false,
  enableGlobalFilter: false,
  enableGrouping: false,
  enableHiding: false,
  enableResizing: false,
  enableSorting: false,
} as Partial<MRT_ColumnDef>;

All of these values are able to be overridden if needed, and you'll learn about that in the next section down below.

It is possible to change and override the default behavior of built-in display columns. Whether you want to change the default column width, add some styles, or enable some features, such as column actions or column drag and drop, you can do it with the displayColumnDefOptions table option.

Let's say you need to adjust the width of the Actions column to be wide enough to fit all of your action buttons. You could do that as follows:

const table = useMantineReactTable({
  columns,
  data,
  displayColumnDefOptions: { 'mrt-row-actions': { size: 300 } }, //change width of actions column to 300px
  enableRowActions: true,
  renderRowActions: ({ row }) => (
    <div>
      <Button>Action 1</Button>
      <Button>Action 2</Button>
      <Button>Action 3</Button>
    </div>
  ),
});

return <MantineReactTable table={table} />;

Or maybe you want to enable a feature that is off by default for display columns, such as column ordering or pinning.

const table = useMantineReactTable({
  columns,
  data,
  displayColumnDefOptions: {
    'mrt-row-numbers': {
      enableOrdering: true,
      enableColumnPinning: true,
      enableColumnActions: true,
    },
  },
  enableRowNumbers: true,
});

Here is a full example and demo for customizing display columns.

import '@mantine/core/styles.css';
import '@mantine/dates/styles.css'; //if using mantine date picker features
import 'mantine-react-table/styles.css'; //make sure MRT styles were imported in your app root (once)
import { useMemo } from 'react';
import { Box, Button } from '@mantine/core';
import { MantineReactTable, type MRT_ColumnDef } from 'mantine-react-table';
import { data, type Person } from './makeData';

const Example = () => {
  const columns = useMemo<MRT_ColumnDef<Person>[]>(
    () => [
      {
        accessorKey: 'firstName',
        header: 'First Name',
      },
      {
        accessorKey: 'lastName',
        header: 'Last Name',
      },
      {
        accessorKey: 'address',
        header: 'Address',
      },
      {
        accessorKey: 'city',
        header: 'City',
      },
      {
        accessorKey: 'state',
        header: 'State',
      },
    ],
    [],
  );

  return (
    <MantineReactTable
      columns={columns}
      data={data}
      displayColumnDefOptions={{
        'mrt-row-actions': {
          size: 350, //set custom width
          mantineTableHeadCellProps: {
            align: 'center', //change head cell props
          },
        },
        'mrt-row-numbers': {
          enableColumnOrdering: true, //turn on some features that are usually off
          enableResizing: true,
          mantineTableHeadCellProps: {
            style: {
              fontSize: '1.2rem',
            },
          },
        },
        'mrt-row-select': {
          enableColumnActions: true,
          enableHiding: true,
          size: 100,
        },
      }}
      enableColumnResizing
      enableColumnOrdering
      enableRowNumbers
      enableRowSelection
      enableRowActions
      renderRowActions={({ row }) => (
        <Box style={{ display: 'flex', gap: '16px' }}>
          <Button>Button 1</Button>
          <Button>Button 2</Button>
          <Button>Button 3</Button>
        </Box>
      )}
    />
  );
};

export default Example;

You do not have to use the built in Row Actions feature. You can just create your own display columns instead. It is as easy as creating a normal column, only specifying the columnDefType as display.

const columns = [
  {
    id: 'sendEmail',
    header: 'Send Email',
    columnDefType: 'display', //turns off data column features like sorting, filtering, etc.
    enableColumnOrdering: true, //but you can turn back any of those features on if you want like this
    Cell: ({ row }) => (
      <Button onClick={() => sendEmail(row.original.userId)}>Send Email</Button>
    ),
  },
  {
    id: 'name',
    header: 'Name',
    accessorKey: 'name',
  },
];