React Grid - Filtering

The Grid component supports filtering data by a column value programmatically or using the value an end user types in the corresponding Filter Row editor. The filtering state management, Filter Row rendering, and filtering logic are implemented in the related plugins.

The following plugins implement filtering features:

Note that plugin order is important.

Basic Setup

Import the plugins listed above to set up a Grid with basic filtering.

Uncontrolled Mode

In uncontrolled mode, specify the initial filtering conditions in the FilteringState plugin's defaultFilters property.

Controlled Mode

In controlled mode, pass the filtering options to the FilteringState plugin's filters property and handle the onFiltersChange event to control the filtering state externally.

Use Custom Filtering Algorithms

You can also specify a filtering predicate using the IntegratedFiltering plugin's columnExtenstions property to implement custom filtering logic for specific columns.

Disable Filtering by a Column

You can prevent filtering by a specific column using the FilteringState plugin's columnExtensions property.

Custom Filter Operations

Specify the TableFilterRow plugin's showFilterSelector property to allow filter operation selection for an end user. Define which filter operations are available for particular columns using the DataTypeProvider availableFilterOperations property. You can also define a custom operation by passing a filtering predicate to the IntegratedFiltering plugin's columnExtensions property.

Customize Filter Row Appearance

Pass a function that returns a custom component to the TableFilterRow plugin's cellComponent property to substitute the built-in filter row editors. In this case, delegate the component's state management to the TableFilterRow plugin by assigning the function's filter and onFilter arguments to the corresponding component properties.

Remote Filtering

It is possible to perform filtering remotely by handling filtering state changes, generating a request, and sending it to the server.

Filtering options are updated once an end user modifies the text in the Filter Row editor or in another filtering control. Handle the filtering option changes using the FilteringState plugin's onFiltersChange event and request data from the server using the applied filtering options. Once the filtered data is received from the server, pass it to the Grid component's rows property.

Note that you do not need to use the IntegratedFiltering plugin for remote filtering.

Use Filtering with Other Data Processing Plugins

The order in which the plugins appear in the Grid's container is important when you use filtering features with paging or grouping. You need to choose whether to paginate filtered rows or filter the current page. In the former case, put the IntegratedFiltering plugin before the IntegratedPaging plugin. Otherwise, inverse the plugins' order.