GridColumnMenuCheckboxFilterProps

The props of the GridColumnMenuFilter component.

NameTypeDefaultDescription

column

GridColumnMenuColumnProps

The current column options.

data

undefined[]

Sets the items collection that will be rendered by the GridColumnMenuCheckboxFilter component.

expanded?

boolean

Controls the expand state of the filter component.

filter?

CompositeFilterDescriptor

The current filter state of the Grid.

filterOperators

GridFilterOperators

The filter operators for the Grid filters.

filterable?

boolean

The filterable option of the column.

onCloseMenu?

Function

The method that will be called to close the column menu.

React.ComponentType<any>

Defines the component that will be rendered as a search box.

searchBoxFilterOperator?

string | Function

Defines the filter operator that will be used to filter the values via the search box. "startswith" "endswith" "contains" "doesnotcontain" "isempty" "isnotempty" "eq" (equal to) "eq" (equal to) "neq" (not equal to) "isnull" (is equal to null) "isnotnull" (is not equal to null)

uniqueData?

boolean

Determines if the data in the component will be unique. By default the property is set to true.

Methods

onExpandChange

Triggered on each subsequent expand state of the filter component.

Parameters

nextExpandState

boolean

onFilterChange

The method that will be called to notify the parent Grid about a filter change.

Parameters

filter

"null" | CompositeFilterDescriptor

syntheticEvent

SyntheticEvent<any>

Returns

any