Skip to content

GridFilterItem API

Extended documentation for the GridFilterItem interface with detailed information on the module's properties and available APIs.

Demos

Import

import { GridFilterItem } from '@mui/x-data-grid-premium'
// or
import { GridFilterItem } from '@mui/x-data-grid-pro'
// or
import { GridFilterItem } from '@mui/x-data-grid'


Filter item definition interface.

Properties

The column from which we want to filter the rows.

Type:GridBaseColDef['field']

The name of the operator we want to apply.
A custom operator is supported by providing any string value.

Type:'contains' | 'doesNotContain' | 'equals' | 'doesNotEqual' | 'startsWith' | 'endsWith' | '=' | '!=' | '>' | '>=' | '<' | '<=' | 'is' | 'not' | 'after' | 'onOrAfter' | 'before' | 'onOrBefore' | 'isEmpty' | 'isNotEmpty' | 'isAnyOf' | (string & {})

Optional

Must be unique.
Only useful when the model contains several items.

Type:number | string

Optional

The filtering value.
The operator filtering function will decide for each row if the row values is correct compared to this value.

Type:any