GridFilterPanel API

API reference docs for the React GridFilterPanel component. Learn about the props, CSS, and other APIs of this exported module.

Component demos

For examples and details on the usage of this React component, visit the component demo pages:

Import

import { GridFilterPanel } from '@mui/x-data-grid/components';
// or
import { GridFilterPanel } from '@mui/x-data-grid';
// or
import { GridFilterPanel } from '@mui/x-data-grid-pro';
// or
import { GridFilterPanel } from '@mui/x-data-grid-premium';

Learn about the difference by reading this guide on minimizing bundle size.

Props

Name	Type	Default	Description
columnsSort	'asc' \| 'desc'		Changes how the options in the columns selector should be ordered. If not specified, the order is derived from the `columns` prop.
disableAddFilterButton	bool	false	If `true`, the `Add filter` button will not be displayed.
disableRemoveAllButton	bool	false	If `true`, the `Remove all` button will be disabled
filterFormProps	{ columnInputProps?: any, columnsSort?: 'asc' \| 'desc', deleteIconProps?: any, filterColumns?: func, logicOperatorInputProps?: any, operatorInputProps?: any, valueInputProps?: any }		Props passed to each filter form.
getColumnForNewFilter	func		Function that returns the next filter item to be picked as default filter. Signature:`function(args: GetColumnForNewFilterArgs) => void` `args` Currently configured filters and columns.
logicOperators	Array<'and' \| 'or'>	[GridLogicOperator.And, GridLogicOperator.Or]	Sets the available logic operators.
sx	Array<func \| object \| bool> \| func \| object		The system prop that allows defining system overrides as well as additional CSS styles. See the `sx` page for more details.

The ref is forwarded to the root element.