MRT logoMaterial React Table

On This Page

    Global Filtering (Search) Feature Guide

    Material 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.

    Relevant Props

    1
    boolean
    true
    MRT Column Filtering Docs
    2
    boolean
    true
    MRT Global Filtering Docs
    3
    boolean
    true
    MRT Global Filtering Docs
    4
    boolean
    true
    MRT Global Filtering Docs
    5
    (column: Column<TData, unknown>) => boolean
    6
    MRT_FilterOption
    7
    Array<MRT_FilterOption | string> | null
    8
    boolean
    TanStack Table Filters Docs
    9
    TextFieldProps | ({ table }) => TextFieldProps
    Material UI TextField Props
    10
    OnChangeFn<GlobalFilterState>
    TanStack Table Filters Docs
    11
    OnChangeFn<GlobalFilterState>
    TanStack Table Filters Docs
    12
    OnChangeFn<boolean>
    13
    'left' | 'right'
    14
    ({ internalFilterOptions, onSelectFilterMode, table }) => ReactNode[]

    Relevant Column Options

    1
    boolean
    MRT Column Filtering Docs
    2
    boolean

    Relevant State Options

    1
    any
    TanStack Table Filtering Docs
    2
    MRT_FilterFn
    3
    boolean
    false

    Disable Global Filtering

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

    Disable Global Filtering per Column

    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',
    },
    ];

    Disable Global Filter Feature

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

    <MaterialReactTable
    columns={columns}
    data={data}
    enableGlobalFilter={false} //disable search feature
    />

    Filter Match Highlighting

    New in v1.6

    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.palette.warning.main 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() to preserve the filter match highlighting.

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

    Disable Filter Match Highlighting

    Filter match highlighting can be disabled by setting the enableFilterMatchHighlighting prop to false.

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

    Client-Side Global Filtering

    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.

    Global Filter Function

    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.

    <MaterialReactTable
    columns={columns}
    data={data}
    globalFilterFn="contains" //turn off fuzzy matching and use simple contains filter function
    />

    Or a custom filter function:

    <MaterialReactTable
    columns={columns}
    data={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.

    Ranked Results

    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 search box, 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 at all, but you still want fuzzy matching, you can set the enableGlobalFilterRankedResults prop to false.

    <MaterialReactTable
    columns={columns}
    data={data}
    enableGlobalFilterRankedResults={false} //preserve the order of the data when fuzzy match searching
    />

    Global Filter Modes

    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 drop-down by setting the globalFilterModeOptions prop or by rendering your own custom menu items with the renderGlobalFilterModeMenuItems prop.

    <MaterialReactTable
    columns={columns}
    data={data}
    enableGlobalFilterModes //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
    />

    Show Search Field by Default

    Additionally, 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.

    Manual Server-Side Global Filtering

    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 in the example below (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]);
    return (
    <MaterialReactTable
    columns={columns}
    data={data} // this will already be filtered on the server
    manualFiltering //turn off client-side filtering
    onGlobalFilterChange={setGlobalFilter} //hoist internal global state to your state
    state={{ globalFilter }} //pass in your own managed globalFilter state
    />
    );

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

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


    Demo

    Open StackblitzOpen Code SandboxOpen on GitHub

    No records to display

    Rows per page

    0-0 of 0

    Source Code

    1import React, { useEffect, useMemo, useState } from 'react';
    2import MaterialReactTable, {
    3 MRT_ColumnDef,
    4 MRT_ColumnFiltersState,
    5 MRT_PaginationState,
    6 MRT_SortingState,
    7} from 'material-react-table';
    8
    9type UserApiResponse = {
    10 data: Array<User>;
    11 meta: {
    12 totalRowCount: number;
    13 };
    14};
    15
    16type User = {
    17 firstName: string;
    18 lastName: string;
    19 address: string;
    20 state: string;
    21 phoneNumber: string;
    22};
    23
    24const Example = () => {
    25 //data and fetching state
    26 const [data, setData] = useState<User[]>([]);
    27 const [isError, setIsError] = useState(false);
    28 const [isLoading, setIsLoading] = useState(false);
    29 const [isRefetching, setIsRefetching] = useState(false);
    30 const [rowCount, setRowCount] = useState(0);
    31
    32 //table state
    33 const [columnFilters, setColumnFilters] = useState<MRT_ColumnFiltersState>(
    34 [],
    35 );
    36 const [globalFilter, setGlobalFilter] = useState('');
    37 const [sorting, setSorting] = useState<MRT_SortingState>([]);
    38 const [pagination, setPagination] = useState<MRT_PaginationState>({
    39 pageIndex: 0,
    40 pageSize: 10,
    41 });
    42
    43 //if you want to avoid useEffect, look at the React Query example instead
    44 useEffect(() => {
    45 const fetchData = async () => {
    46 if (!data.length) {
    47 setIsLoading(true);
    48 } else {
    49 setIsRefetching(true);
    50 }
    51
    52 const url = new URL(
    53 '/api/data',
    54 process.env.NODE_ENV === 'production'
    55 ? 'https://www.material-react-table.com'
    56 : 'http://localhost:3000',
    57 );
    58 url.searchParams.set(
    59 'start',
    60 `${pagination.pageIndex * pagination.pageSize}`,
    61 );
    62 url.searchParams.set('size', `${pagination.pageSize}`);
    63 url.searchParams.set('filters', JSON.stringify(columnFilters ?? []));
    64 url.searchParams.set('globalFilter', globalFilter ?? '');
    65 url.searchParams.set('sorting', JSON.stringify(sorting ?? []));
    66
    67 try {
    68 const response = await fetch(url.href);
    69 const json = (await response.json()) as UserApiResponse;
    70 setData(json.data);
    71 setRowCount(json.meta.totalRowCount);
    72 } catch (error) {
    73 setIsError(true);
    74 console.error(error);
    75 return;
    76 }
    77 setIsError(false);
    78 setIsLoading(false);
    79 setIsRefetching(false);
    80 };
    81 fetchData();
    82 // eslint-disable-next-line react-hooks/exhaustive-deps
    83 }, [
    84 columnFilters,
    85 globalFilter,
    86 pagination.pageIndex,
    87 pagination.pageSize,
    88 sorting,
    89 ]);
    90
    91 const columns = useMemo<MRT_ColumnDef<User>[]>(
    92 () => [
    93 {
    94 accessorKey: 'firstName',
    95 header: 'First Name',
    96 },
    97 //column definitions...
    115 ],
    116 [],
    117 );
    118
    119 return (
    120 <MaterialReactTable
    121 columns={columns}
    122 data={data}
    123 enableRowSelection
    124 getRowId={(row) => row.phoneNumber}
    125 initialState={{ showColumnFilters: true }}
    126 manualFiltering
    127 manualPagination
    128 manualSorting
    129 muiToolbarAlertBannerProps={
    130 isError
    131 ? {
    132 color: 'error',
    133 children: 'Error loading data',
    134 }
    135 : undefined
    136 }
    137 onColumnFiltersChange={setColumnFilters}
    138 onGlobalFilterChange={setGlobalFilter}
    139 onPaginationChange={setPagination}
    140 onSortingChange={setSorting}
    141 rowCount={rowCount}
    142 state={{
    143 columnFilters,
    144 globalFilter,
    145 isLoading,
    146 pagination,
    147 showAlertBanner: isError,
    148 showProgressBars: isRefetching,
    149 sorting,
    150 }}
    151 />
    152 );
    153};
    154
    155export default Example;
    156

    Customize Global Filter Position

    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.

    <MaterialReactTable
    columns={columns}
    data={data}
    positionGlobalFilter="left" //show the global filter on the left side of the top toolbar
    initialState={{
    showGlobalFilter: true, //show the global filter by default
    }}
    />

    Customize the Search Text Field

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

    <MaterialReactTable
    columns={columns}
    data={data}
    muiSearchTextFieldProps={{
    placeholder: 'Search all users',
    sx: { minWidth: '300px' },
    variant: 'outlined',
    }}
    />

    Demo

    1HughJayMungus42
    2LeroyLeroyJenkins51
    3CandiceDeniseNutella27
    4MicahHenryJohnson32

    Rows per page

    1-4 of 4

    Source Code

    1import React, { useMemo } from 'react';
    2import MaterialReactTable, { MRT_ColumnDef } from 'material-react-table';
    3import { data, Person } from './makeData';
    4
    5const Example = () => {
    6 const columns = useMemo<MRT_ColumnDef<Person>[]>(
    7 //column definitions...
    32 );
    33
    34 return (
    35 <MaterialReactTable
    36 columns={columns}
    37 data={data}
    38 enableGlobalFilterModes
    39 initialState={{
    40 showGlobalFilter: true,
    41 }}
    42 positionGlobalFilter="left"
    43 muiSearchTextFieldProps={{
    44 placeholder: `Search ${data.length} rows`,
    45 sx: { minWidth: '300px' },
    46 variant: 'outlined',
    47 }}
    48 />
    49 );
    50};
    51
    52export default Example;
    53

    View Extra Storybook Examples