Components / Data Grid / API / GridFilterCellProps / 

GridFilterCellProps

The props of the GridFilterCell component (more information and example).

NameTypeDefaultDescription

ariaLabel?

string

Accessible label of the filter.

booleanValues

GridFilterOperator[]

The list of values for the Boolean filter.

field?

string

The column field in which the cell is located.

filterType

"boolean" | "numeric" | "text" | "date"

The type of the filter. Determines which editor will be rendered for filtering.

operator?

string | Function

The operator that will be used for the cell filtering.

operators

GridFilterOperator[]

The list of the default operators for the current filter type.

size?

"null" | "small" | "medium" | "large"

medium

Configures the size of the cell.

The available options are:

  • small
  • medium
  • large
  • null—Does not set a size className.

title?

string

The title which will be set to the input element in the filter cell.

value

any

The value of the cell.

Methods

onChange

The method that will be called if the cell needs to inform its parent Grid about a change.

Parameters

event

{ operator: string | Function; syntheticEvent: SyntheticEvent<any>; value: any; }

render

A function for overriding the default rendering of the filter cell.

Parameters

row

ReactElement<any>

dataItem

GridFilterCellProps
Returns

ReactNode

In this article

Not finding the help you need?

Contact Support