Column visibility

DataGrid show and hide columns

Basic column visibility

Pass withColumnVisibility to useDataGrid to let users show and hide columns. DataGrid.ColumnVisibilityToggle renders a button with a menu of columns, DataGrid.Toolbar without children renders it automatically:

First Name
Last Name
Email
Department
Salary
Status
AliceJohnsonalice.johnson@example.comEngineering95000active
BobSmithbob.smith@example.comMarketing72000active
CarolWilliamscarol.williams@example.comSales68000active
DavidBrowndavid.brown@example.comHR65000inactive
EvaDaviseva.davis@example.comFinance88000active
FrankMillerfrank.miller@example.comEngineering102000active
GraceWilsongrace.wilson@example.comMarketing76000active
HenryTaylorhenry.taylor@example.comSales71000inactive
IreneAndersonirene.anderson@example.comEngineering97000active
JamesThomasjames.thomas@example.comFinance91000active
KarenJacksonkaren.jackson@example.comHR63000active
LeoWhiteleo.white@example.comEngineering110000active
MiaHarrismia.harris@example.comSales74000active
NathanMartinnathan.martin@example.comMarketing69000inactive
OliviaGarciaolivia.garcia@example.comFinance85000active
PatrickMartinezpatrick.martinez@example.comEngineering99000active
QuinnRobinsonquinn.robinson@example.comHR67000active
RachelClarkrachel.clark@example.comSales73000active
import { DataGrid, useDataGrid } from '@mantine/data-grid';
import { employees } from './data';

function Demo() {
  const store = useDataGrid({
    data: employees,
    columns: [
      { accessorKey: 'firstName', header: 'First Name' },
      { accessorKey: 'lastName', header: 'Last Name' },
      { accessorKey: 'email', header: 'Email', size: 220 },
      { accessorKey: 'department', header: 'Department' },
      { accessorKey: 'salary', header: 'Salary' },
      { accessorKey: 'status', header: 'Status' },
    ],
    withColumnVisibility: true,
  });

  return (
    <DataGrid store={store}>
      <DataGrid.Toolbar>
        <DataGrid.ColumnVisibilityToggle />
      </DataGrid.Toolbar>
    </DataGrid>
  );
}

Controlled visibility state

Pass columnVisibility and onColumnVisibilityChange to useDataGrid for controlled state. The state is an object of column ids and boolean values:

First Name
Last Name
Email
Department
Salary
Status
AliceJohnsonalice.johnson@example.comEngineering95000active
BobSmithbob.smith@example.comMarketing72000active
CarolWilliamscarol.williams@example.comSales68000active
DavidBrowndavid.brown@example.comHR65000inactive
EvaDaviseva.davis@example.comFinance88000active
FrankMillerfrank.miller@example.comEngineering102000active
GraceWilsongrace.wilson@example.comMarketing76000active
HenryTaylorhenry.taylor@example.comSales71000inactive
IreneAndersonirene.anderson@example.comEngineering97000active
JamesThomasjames.thomas@example.comFinance91000active
KarenJacksonkaren.jackson@example.comHR63000active
LeoWhiteleo.white@example.comEngineering110000active
MiaHarrismia.harris@example.comSales74000active
NathanMartinnathan.martin@example.comMarketing69000inactive
OliviaGarciaolivia.garcia@example.comFinance85000active
PatrickMartinezpatrick.martinez@example.comEngineering99000active
QuinnRobinsonquinn.robinson@example.comHR67000active
RachelClarkrachel.clark@example.comSales73000active
import { useState } from 'react';
import { ColumnVisibilityState } from '@tanstack/react-table';
import { Checkbox, Group } from '@mantine/core';
import { DataGrid, useDataGrid } from '@mantine/data-grid';
import { employees } from './data';

const allColumns = ['firstName', 'lastName', 'email', 'department', 'salary', 'status'];

function Demo() {
  const [columnVisibility, setColumnVisibility] = useState<ColumnVisibilityState>({});

  const store = useDataGrid({
    data: employees,
    columns: [
      { accessorKey: 'firstName', header: 'First Name' },
      { accessorKey: 'lastName', header: 'Last Name' },
      { accessorKey: 'email', header: 'Email', size: 220 },
      { accessorKey: 'department', header: 'Department' },
      { accessorKey: 'salary', header: 'Salary' },
      { accessorKey: 'status', header: 'Status' },
    ],
    columnVisibility,
    onColumnVisibilityChange: setColumnVisibility,
  });

  const visibleColumns = allColumns.filter((col) => columnVisibility[col] !== false);

  return (
    <>
      <Checkbox.Group value={visibleColumns} onChange={(value) => {
        const next: ColumnVisibilityState = {};
        allColumns.forEach((col) => {
          next[col] = value.includes(col);
        });
        setColumnVisibility(next);
      }} mb="md">
        <Group>
          {allColumns.map((col) => (
            <Checkbox key={col} value={col} label={col} />
          ))}
        </Group>
      </Checkbox.Group>
      <DataGrid store={store} />
    </>
  );
}

Disable hiding per column

Set enableHiding: false on a column definition to prevent the column from being hidden. Such columns are not listed in the visibility menu:

First Name
Last Name
Email
Department
Salary
Status
AliceJohnsonalice.johnson@example.comEngineering95000active
BobSmithbob.smith@example.comMarketing72000active
CarolWilliamscarol.williams@example.comSales68000active
DavidBrowndavid.brown@example.comHR65000inactive
EvaDaviseva.davis@example.comFinance88000active
FrankMillerfrank.miller@example.comEngineering102000active
GraceWilsongrace.wilson@example.comMarketing76000active
HenryTaylorhenry.taylor@example.comSales71000inactive
IreneAndersonirene.anderson@example.comEngineering97000active
JamesThomasjames.thomas@example.comFinance91000active
KarenJacksonkaren.jackson@example.comHR63000active
LeoWhiteleo.white@example.comEngineering110000active
MiaHarrismia.harris@example.comSales74000active
NathanMartinnathan.martin@example.comMarketing69000inactive
OliviaGarciaolivia.garcia@example.comFinance85000active
PatrickMartinezpatrick.martinez@example.comEngineering99000active
QuinnRobinsonquinn.robinson@example.comHR67000active
RachelClarkrachel.clark@example.comSales73000active
import { DataGrid, useDataGrid } from '@mantine/data-grid';
import { employees } from './data';

function Demo() {
  const store = useDataGrid({
    data: employees,
    columns: [
      { accessorKey: 'firstName', header: 'First Name', enableHiding: false },
      { accessorKey: 'lastName', header: 'Last Name', enableHiding: false },
      { accessorKey: 'email', header: 'Email', size: 220 },
      { accessorKey: 'department', header: 'Department' },
      { accessorKey: 'salary', header: 'Salary' },
      { accessorKey: 'status', header: 'Status' },
    ],
    withColumnVisibility: true,
  });

  return (
    <DataGrid store={store}>
      <DataGrid.Toolbar>
        <DataGrid.ColumnVisibilityToggle />
      </DataGrid.Toolbar>
    </DataGrid>
  );
}

Column menu

With withColumnMenu on DataGrid, every hideable column gets a Hide column item in its header menu, see Customization.

Toggle all columns

Use the table instance to show or hide all columns:

const store = useDataGrid({ data, columns, withColumnVisibility: true });

// Hide all columns
store.table.toggleAllColumnsVisible(false);

// Show all columns
store.table.toggleAllColumnsVisible(true);

Programmatic visibility

Use the column instance to show or hide one column:

// Toggle a specific column
store.table.getColumn('email')?.toggleVisibility();

// Set visibility explicitly
store.table.getColumn('email')?.toggleVisibility(false);

Initial hidden columns

Pass columnVisibility to useDataGrid to hide columns initially:

const store = useDataGrid({
  data,
  columns,
  columnVisibility: { email: false, startDate: false },
});