import Head from 'next/head'; import Box from '@mui/material/Box'; import TableOptionsTable from '../../../components/prop-tables/TableOptionsTable'; import ColumnOptionsTable from '../../../components/prop-tables/ColumnOptionsTable'; import StateOptionsTable from '../../../components/prop-tables/StateOptionsTable'; import AlternateExample from '../../../examples/alternate-column-filtering'; import CustomizeFilterVariantsExample from '../../../examples/customize-filter-variants'; import CustomizeFilterModesExample from '../../../examples/customize-filter-modes'; import CustomizeFilterComponentsExample from '../../../examples/customize-filter-components'; import EnableColumnFacetValuesExample from '../../../examples/enable-filter-facet-values';
<title>{'Column Filtering Guide - Material React Table V2 Docs'}</title>Filtering is one of the most powerful features of Material React Table and is enabled by default. There is a lot of flexibility and customization available here. Whether you want to customize the powerful client-side filtering already built in or implement your own server-side filtering, Material React Table has got you covered.
<TableOptionsTable onlyOptions={ new Set([ 'columnFilterModeOptions', 'enableColumnFilterModes', 'enableColumnFilters', 'enableFacetedValues', 'enableFilterMatchHighlighting', 'enableFilters', 'filterFns', 'filterFromLeafRows', 'getFacetedMinMaxValues', 'getFacetedRowModel', 'getFacetedUniqueValues', 'getFilteredRowModel', 'manualFiltering', 'maxLeafRowFilterDepth', 'muiFilterAutocompleteProps', 'muiFilterCheckboxProps', 'muiFilterDatePickerProps', 'muiFilterDateTimePickerProps', 'muiFilterSliderProps', 'muiFilterTextFieldProps', 'muiFilterTimePickerProps', 'onColumnFilterFnsChange', 'onColumnFiltersChange', 'onShowColumnFiltersChange', 'renderColumnFilterModeMenuItems', ]) } />
<ColumnOptionsTable onlyOptions={ new Set([ 'Filter', 'columnFilterModeOptions', 'enableColumnFilter', 'enableColumnFilterModes', 'enableFilterMatchHighlighting', 'filterFn', 'filterSelectOptions', 'filterVariant', 'muiFilterAutocompleteProps', 'muiFilterCheckboxProps', 'muiFilterDatePickerProps', 'muiFilterDateTimePickerProps', 'muiFilterSliderProps', 'muiFilterTextFieldProps', 'muiFilterTimePickerProps', 'renderColumnFilterModeMenuItems', ]) } />
<StateOptionsTable onlyOptions={ new Set(['columnFilters', 'columnFilterFns', 'showColumnFilters']) } />
Various subsets of filtering features can be disabled. If you want to disable filtering completely, you can set the enableColumnFilters table option to false to remove all filters from each column. Alternatively, enableColumnFilter can be set to false for individual columns.
enableFilters can be set to false to disable both column filters and the global search filter.
Material React Table has several built-in filter variants for advanced filtering. These can be specified on a per-column basis using the filterVariant option. The following variants are available:
'text'- shows the default text field'autocomplete'- shows an autocomplete text field with the options from faceted values or specified infilterSelectOptionsarray.'select'- shows a select dropdown with the options from faceted values or specified infilterSelectOptionsarray.'multi-select'- shows a select dropdown with the options from faceted values or specified infilterSelectOptionsand allows multiple selections with checkboxes'range'- shows min and max text fields for filtering a range of values'range-slider'- shows a slider for filtering a range of values'date'- shows a date picker for filtering by date values'datetime'- shows a date and time picker for filtering by date and time values'date-range'- shows a date range picker for filtering by date ranges'datetime-range'- shows a date and time range picker for filtering by date and time ranges'time'- shows a time picker for filtering by time values'time-range'- shows a time range picker for filtering by time ranges'checkbox'- shows a checkbox for filtering by'true'or'false'values
'autocomplete','date', and'date-range', variants are new in v2.0.0
datetime,datetime-range,time, andtime-rangevariants are new in v2.4.0
Faceted values are a list of unique values for a column that gets generated under the hood from table data when the enableFacetedValues table option is set to true. These values can be used to populate the select dropdowns for the 'select' and 'multi-select' filter variants, or the min and max values for the 'range-slider' variant. This means that you no longer need to manually specify the filterSelectOptions table option for these variants manually, especially if you are using client-side filtering.
If you are using server-side pagination and filtering, you can still customize the faceted values output with the getFacetedUniqueValues and getFacetedMinMaxValues props.
const table = useMaterialReactTable({
columns,
data,
enableFacetedValues: true,
//if using server-side pagination and filtering
getFacetedMinMaxValues: (table) => {
//fetch min and max values from server
return [minValue, maxValue];
},
//if using server-side filtering
getFacetedUniqueValues: (table) => {
const uniqueValueMap = new Map<string, number>();
//fetch unique values from server, ideally including the count of each unique value
return uniqueValueMap;
},
})By default, column filters inputs show below the column header. You can switch to a more "excel-like" UI by setting the columnFilterDisplayMode table option to 'popover'. This will show a filter icon in the column header that can be clicked to open a popover with the filter input.
const table = useMaterialReactTable({
columns,
data,
columnFilterDisplayMode: 'popover', //filter inputs will show in a popover (like excel)
});Alternatively, if you want to render your own column filter UI in a separate sidebar, but still want to use the built-in filtering functionality, you can set the columnFilterDisplayMode table option to 'custom'.
const table = useMaterialReactTable({
columns,
data,
columnFilterDisplayMode: 'custom', //render your own column filter UI (e.g. in a sidebar)
});You can specify either a pre-built filterFn that comes with Material React Table or pass in your own custom filter functions.
By default, Material React Table uses a fuzzy filtering algorithm based on the popular match-sorter library from Kent C. Dodds. However, Material React Table also comes with numerous other filter functions that you can specify per column in the filterFn column options.
Pre-built filter functions from Material React Table include
between,betweenInclusive,contains,empty,endsWith,equals,fuzzy,greaterThan,greaterThanOrEqualTo,lessThan,lessThanOrEqualTo,notEmpty,notEquals, andstartsWith. View these algorithms here
Pre-built filter functions from TanStack Table include
includesString,includesStringSensitive,equalsString,equalsStringSensitive,arrIncludes,arrIncludesAll,arrIncludesSome,weakEquals, andinNumberRange. View more information about these algorithms in the TanStack Table Filter docs.
You can specify either a pre-built filter function, from Material React Table or TanStack Table, or you can even specify your own custom filter function in the filterFn column option.
const columns = [
{
accessorKey: 'firstName',
header: 'First Name',
// using a prebuilt filter function from Material React Table
filterFn: 'startsWith',
},
{
accessorKey: 'middleName',
header: 'Middle Name',
// using a prebuilt filter function from TanStack Table
filterFn: 'includesStringSensitive',
},
{
accessorKey: 'lastName',
header: 'Last Name',
// custom filter function
filterFn: (row, id, filterValue) =>
row.getValue(id).startsWith(filterValue),
},
];If you provide a custom filter function, it must have the following signature:
(row: Row<TData>, id: string, filterValue: string | number) => boolean;This function will be used to filter 1 row at a time and should return a boolean indicating whether or not that row passes the filter.
You can add custom filter functions to the filterFns table option. These will be available to all columns to use. The filterFn table option on a column will override any filter function with the same name in the filterFns table option.
const columns = [
{
accessorKey: 'name',
header: 'Name',
filterFn: 'customFilterFn',
},
];
const table = useMaterialReactTable({
columns,
data,
filterFns: {
customFilterFn: (row, id, filterValue) => {
return row.customField === value;
},
},
});If you want to let the user switch between multiple different filter modes from a drop-down menu on the Filter Textfield, you can enable that with the enableColumnFilterModes table option or column option. This will enable the filter icon in the filter text field to open a drop-down menu with the available filter modes when clicked.
const table = useMaterialReactTable({
columns,
data,
enableColumnFilterModes: true,
});You can narrow down the available filter mode options by setting the columnFilterModeOptions table option or a column specific columnFilterModeOptions option.
const columns = [
{
accessorKey: 'firstName',
header: 'First Name',
columnFilterModeOptions: ['fuzzy', 'contains', 'startsWith'],
},
{
accessorKey: 'age',
header: 'Age',
columnFilterModeOptions: ['between', 'lessThan', 'greaterThan'],
},
];You can also render custom menu items in the filter mode drop-down menu by setting the renderColumnFilterModeMenuItems table option or column option. This option is a function that takes in the column and returns an array of MenuItem components. This is useful if you want to add custom filter modes that are not included in Material React Table, or if you just want to render the menu in your own custom way
const columns = [
{
accessorKey: 'firstName',
header: 'First Name',
renderColumnFilterModeMenuItems: ({ column, onSelectFilterMode }) => [
<MenuItem
key="startsWith"
onClick={() => onSelectFilterMode('startsWith')}
>
Start With
</MenuItem>,
<MenuItem
key="endsWith"
onClick={() => onSelectFilterMode('yourCustomFilterFn')}
>
Your Custom Filter Fn
</MenuItem>,
],
},
];
const table = useMaterialReactTable({
columns,
data,
enableColumnFilterModes: true,
// renderColumnFilterModeMenuItems could go here if you want to apply to all columns
});
return <MaterialReactTable table={table} />;If you are using the filtering features along-side either the grouping or expanding features, then there are a few behaviors and customizations you should be aware of.
Check out the Expanded Leaf Row Filtering Behavior docs to learn more about the filterFromLeafRows and maxLeafRowFilterDepth props.
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 table option to true and manage the columnFilters state yourself like so (can work in conjunction with manual global filtering).
// You can manage and have control over the columnFilters state yourself
const [columnFilters, setColumnFilters] = 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]);
};
}, [columnFilters]);
const table = useMaterialReactTable({
columns,
data, // this will already be filtered on the server
manualFiltering: true, //turn off client-side filtering
onColumnFiltersChange: setColumnFilters, //hoist internal columnFilters state to your state
state: { columnFilters }, //pass in your own managed columnFilters state
});
return <MaterialReactTable table={table} />;Specifying
manualFilteringturns off all client-side filtering and assumes that thedatayou pass to<MaterialReactTable />is already filtered.
See either the React Query or useEffect fetching examples to see fully server-side filtering, pagination, and sorting in action.
You can customize the Material UI filter components by setting the muiFilterTextFieldProps table option or column option.
You can also turn a filter textfield into a select dropdown by setting the filterSelectOptions table option or column option.
If you need custom filter components that are much more complex than text-boxes and dropdowns, you can create and pass in your own filter components using the Filter column option.
Filter Match Highlighting is a new featured enabled by default that will highlight text in the table body cells that matches the current filter query with a shade of the theme.palette.warning.main color.
Filter Match Highlighting will only work on columns with the default text filter variant. Also, if you are using a custom Cell render override for a column, you will need to use the renderedCellValue table option 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()
},
];This feature can be disabled by setting the enableFilterMatchHighlighting table option to false.
const table = useMaterialReactTable({
columns,
data,
enableFilterMatchHighlighting: false,
});View Extra Storybook Examples