Skip to content
Edit this page

GridFilterPanel API

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

Demos

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

Import

import GridFilterPanel from '/packages/grid/x-data-grid/src/components/panel/filterPanel/GridFilterPanel.tsx/GridFilterPanel';
// or
import { GridFilterPanel } from '/packages/grid/x-data-grid/src/components/panel/filterPanel/GridFilterPanel.tsx';
Learn about the difference by reading this guide on minimizing bundle size.

Props

columnsSort

Changes how the options in the columns selector should be ordered. If not specified, the order is derived from the columns prop.

Type:

'asc' | 'desc'
disableAddFilterButton

If true, the Add filter button will not be displayed.

Type:

bool
disableRemoveAllButton

If true, the Remove all button will be disabled

Type:

bool
filterFormProps

Props passed to each filter form.

Type:

{ columnInputProps?: any, columnsSort?: 'asc' | 'desc', deleteIconProps?: any, filterColumns?: func, logicOperatorInputProps?: any, operatorInputProps?: any, valueInputProps?: any }
getColumnForNewFilter

Function that returns the next filter item to be picked as default filter.

Type:

func

Signature:

function(args: GetColumnForNewFilterArgs) => void
  • args Currently configured filters and columns.
logicOperators

Sets the available logic operators.

Type:

Array<'and' | 'or'>

Default:

[GridLogicOperator.And, GridLogicOperator.Or]
sx

The system prop that allows defining system overrides as well as additional CSS styles.

See the `sx` page for more details.

Type:

Array<func | object | bool> | func | object
The ref is forwarded to the root element.