MRT logoMaterial React Table

    Column Actions Feature Guide

    By default, Material React Table renders a column actions button for each column header. It contains a drop-down menu to help your users use the other features of the table. All of these actions can be triggered in some other way other than from this drop-down menu, so this serves as a UI/UX alternative to make sure your users can find many of the table features easily.

    Relevant Props

    1
    boolean
    true
    MRT Column Actions Docs
    2
    IconButtonProps | (({table, column}) => IconButtonProps);
    Material UI IconButton Props
    3
    ({ closeMenu, column, table }) => ReactNode[]

    Relevant Column Options

    1
    boolean
    MRT Column Actions Docs
    2
    IconButtonProps | ({ column, table }) => IconButtonProps
    Material UI IconButton API
    3

    Disable or Hide Column Actions Buttons

    You can set the enableColumnActions prop to false in the table to disable this feature and hide the button in each column header completely.

    <MaterialReactTable data={data} columns={columns} enableColumnActions={false} />

    Alternatively, if you only want to hide the column actions button in specific columns, you can set the enableColumnActions property for the desired column definition to false instead.

    In this demo, we disable the column actions button for the 'ID' column.


    Demo

    Open StackblitzOpen Code SandboxOpen on GitHub
    1DylanMurray
    2RaquelKohler

    Rows per page

    1-2 of 2

    Source Code

    1import React, { FC, useMemo } from 'react';
    2import MaterialReactTable, { MRT_ColumnDef } from 'material-react-table';
    3
    4const Example: FC = () => {
    5 const columns = useMemo(
    6 () =>
    7 [
    8 {
    9 accessorKey: 'id',
    10 enableColumnActions: false,
    11 header: 'ID',
    12 },
    13 {
    14 accessorKey: 'firstName',
    15 header: 'First Name',
    16 },
    17 {
    18 accessorKey: 'lastName',
    19 header: 'Last Name',
    20 },
    21 ] as MRT_ColumnDef<typeof data[0]>[],
    22 [],
    23 );
    24
    25 const data = useMemo(
    26 //data definitions...
    41 );
    42
    43 return <MaterialReactTable columns={columns} data={data} />;
    44};
    45
    46export default Example;
    47

    Justify Column Actions Button

    Changed to left alignment in v1.2.0

    By default, the column actions button is left aligned directly after the column header text and any sort or filter labels that may be present. If you want to change this, you can use a CSS selector in muiTableHeadCellProps to change the justify-content property of the column header container.


    1DillonHowler
    2RossEverest

    Rows per page

    1-2 of 2

    Source Code

    1import React, { FC, useMemo } from 'react';
    2import MaterialReactTable, { MRT_ColumnDef } from 'material-react-table';
    3
    4const data =
    5 //data definitions...
    18
    19const Example: FC = () => {
    20 const columns = useMemo<MRT_ColumnDef<typeof data[0]>[]>(
    21 //column definitions...
    37 );
    38
    39 return (
    40 <MaterialReactTable
    41 columns={columns}
    42 data={data}
    43 muiTableHeadCellProps={{
    44 sx: {
    45 '& .Mui-TableHeadCell-Content': {
    46 justifyContent: 'space-between',
    47 },
    48 },
    49 }}
    50 />
    51 );
    52};
    53
    54export default Example;
    55

    Custom Column Actions Menu

    If you do not like the default column actions menu items that Material React Table generates, you can provide your own custom menu items with the renderColumnActionsMenuItems prop. x of the column in the table.

    const columns = [
    {
    accessorKey: 'salary',
    header: 'Salary',
    renderColumnActionsMenuItems: ({ closeMenu, column, table }) => {
    return [
    <MenuItem
    onClick={() => {
    // do something
    closeMenu();
    }}
    >
    Custom Menu Item 1
    </MenuItem>,
    <MenuItem
    onClick={() => {
    // do something
    closeMenu();
    }}
    >
    Custom Menu Item 2
    </MenuItem>,
    ];
    },
    },
    ];
    return (
    <MaterialReactTable
    data={data}
    columns={columns}
    //renderColumnActionsMenuItems could go here if you want to apply it to all columns
    />
    );

    View Extra Storybook Examples