Skip to content
Edit this page

GridFilterPanel API

API documentation for the React GridFilterPanel component. Learn about the available props and the CSS API.

Import

import { GridFilterPanel } from '@mui/x-data-grid-premium';
// or
import { GridFilterPanel } from '@mui/x-data-grid-pro';
// or
import { GridFilterPanel } from '@mui/x-data-grid';
You can learn about the difference by reading this guide on minimizing bundle size.

Component name

The name MuiDataGrid can be used when providing default props or style overrides in the theme.

Props

NameTypeDefaultDescription
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.
filterFormProps{ columnInputProps?: any, columnsSort?: 'asc'
| 'desc', deleteIconProps?: any, linkOperatorInputProps?: any, operatorInputProps?: any, valueInputProps?: any }
Props passed to each filter form.
getColumnForNewFilterfunc
Function that returns the next filter item to be picked as default filter.

Signature:
function(args: GetColumnForNewFilterArgs) => void
args: Currently configured filters and columns.
linkOperatorsArray<'and'
| 'or'>		[GridLinkOperator.And, GridLinkOperator.Or]
Sets the available logic operators.
sxArray<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.

Demos