Mantine React Table

Mantine React Table has a powerful built-in global filtering (search) feature that uses a fuzzy matching algorithm and ranks/sorts the results based on how closely rows match the search query. In this guide we'll cover how to use, customize, or disable the global filter and search features to fit your needs.

You can either disable the global filter feature entirely, or disable it for specific columns.

If you simply want to not include a column as one of the columns that the global filter scans through during filtering, you can set the enableGlobalFilter option to false for that column.

const columns = [
  {
    accessorKey: 'id',
    header: 'Id',
    enableGlobalFilter: false, // do not scan this column during global filtering
  },
  {
    accessorKey: 'name',
    header: 'Name',
  },
];

You can disable the global filtering feature and hide the search icon by setting the enableGlobalFilter prop to false.

const table = useMantineReactTable({
  columns,
  data,
  enableGlobalFilter: false, //disable search feature
});

Filter Match Highlighting is a new featured enabled by default that will highlight text in the table body cells that matches the current search query with a shade of the theme.colors.yellow color.

If you are using a custom Cell render override for a column, you will need to use the renderedCellValue prop instead of cell.getValue() in order to preserve the filter match highlighting.

const columns = [
  {
    accessorKey: 'name',
    header: 'Name',
    Cell: ({ renderedCellValue }) => <span>{renderedCellValue}</span>, // use renderedCellValue instead of cell.getValue()
  },
];

Filter Match Highlighting can be disabled by setting the enableFilterMatchHighlighting prop to false.

const table = useMantineReactTable({
  columns,
  data,
  enableFilterMatchHighlighting: false,
});

Client-side filtering (and global filtering) is enabled by default. This means that the search box will scan through all columns and try to find matches for the search term.

You can use any of the built-in filterFns or any of the custom filter functions that you have defined in the filterFns prop, just like you would with the column filters.

const table = useMantineReactTable({
  columns,
  data,
  globalFilterFn: 'contains', //turn off fuzzy matching and use simple contains filter function
});

or a custom filter function:

const table = useMantineReactTable({
  columns,
  data,
  filterFns: {
    myCustomFilterFn: (row, id, filterValue) =>
      row.getValue(id).startsWith(filterValue),
  },
  globalFilterFn: 'myCustomFilterFn', //set the global filter function to myCustomFilterFn
});

The default global filter function is set to fuzzy, which is a filtering algorithm based on the popular match-sorter library from Kent C. Dodds, though you can change the global filter function by setting the globalFilterFn prop.

If you keep the default fuzzy filterFn option as the global filter function, you get an extra ranked results feature enabled by default. This means that when a user searches with the searchbox, the results will be sorted by the closest match first instead of the order the data was defined in.

The ranked results feature will disable itself automatically if a sort direction is applied to a column, if any sub-rows are expanded, or if any of the manual props are set to true.

If you do not want ranked results to be enabled, but you still want fuzzy matching, you can set the enableGlobalFilterRankedResults prop to false.

const table = useMantineReactTable({
  columns,
  data,
  enableGlobalFilterRankedResults: false, //preserve the order of the data when fuzzy match searching
});

Similar to the column filter modes, you can enable the user to be able to choose between multiple different filter modes for the global filter with the enableGlobalFilterModes prop. You can then customize which filter modes are available in the dropdown by setting the globalFilterModeOptions prop, or by rendering your own custom menu items with the renderGlobalFilterModeMenuItems prop.

const table = useMantineReactTable({
  columns,
  data,
  enableGlobalFilterModes: true, //enable the user to choose between multiple search filter modes
  globalFilterModeOptions: ['fuzzy', 'startsWith'], //only allow the user to choose between fuzzy and startsWith filter modes
});

Also, if you want to show the search text box by default and not hide it behind the search icon, you can set the showGlobalFilter state to true in the initialState.

You can customize the position of the global filter (search box) in the top toolbar by setting the positionGlobalFilter prop to left or right. It is shown on the right by default.

const table = useMantineReactTable({
  columns,
  data,
  positionGlobalFilter: 'left', //show the global filter on the left side of the top toolbar
  initialState: {
    showGlobalFilter: true, //show the global filter by default
  },
});

You can customize the search text field by passing in props to the mantineSearchTextInputProps prop. This is useful if you want to customize the placeholder text, add styles, or any other text field props.

const table = useMantineReactTable({
  columns,
  data,
  mantineSearchTextInputProps: {
    placeholder: 'Search all users',
    style: { minWidth: '300px' },
    variant: 'outlined',
  },
});

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 { MantineReactTable, type MRT_ColumnDef } from 'mantine-react-table';
import { data, type Person } from './makeData';

const Example = () => {
  const columns = useMemo<MRT_ColumnDef<Person>[]>(
    () => [
      {
        accessorKey: 'id',
        header: 'ID',
      },
      {
        accessorKey: 'firstName',
        header: 'First Name',
      },
      {
        accessorKey: 'middleName',
        header: 'Middle Name',
      },
      {
        accessorKey: 'lastName',
        header: 'Last Name',
      },
      {
        accessorKey: 'age',
        header: 'Age',
      },
    ],
    [],
  );

  return (
    <MantineReactTable
      columns={columns}
      data={data}
      enableGlobalFilterModes
      initialState={{
        showGlobalFilter: true,
      }}
      positionGlobalFilter="left"
      mantineSearchTextInputProps={{
        placeholder: `Search ${data.length} rows`,
        style: { minWidth: '300px' },
        variant: 'filled',
      }}
    />
  );
};

export default Example;

A very common use case when you have a lot of data is to filter the data on the server, instead of client-side. In this case you will want to set the manualFiltering prop to true and manage the globalFilter state yourself like so. (Can work in conjuntion with manual column filtering)

// You can manage and have control over the columnFilters state yourself
const [globalFilter, setGlobalFilter] = useState('');
const [data, setData] = useState([]); //data will get updated after re-fetching

useEffect(() => {
  const fetchData = async () => {
    // send api requests when columnFilters state changes
    const filteredData = await fetch();
    setData([...filteredData]);
  };
}, [globalFilter]);

const table = useMantineReactTable({
  columns,
  data, // this will already be filtered on the server
  manualFiltering: true, //turn off client-side filtering
  onGlobalFilterChange: setGlobalFilter, //hoist internal global state to your state
  state: { globalFilter }, //pass in your own managed globalFilter state
});

return <MantineReactTable table={table} />;

Specifying manualFiltering turns off all client-side filtering, and assumes that the data you pass to <MantineReactTable /> is already filtered.

See the full Remote Data example showing off server-side filtering, pagination, and sorting.

View Extra Storybook Examples