| layout | post |
|---|---|
| title | Filter menu in React Grid component | Syncfusion |
| description | Learn here all about Filter menu in Syncfusion React Grid component of Syncfusion Essential JS 2 and more. |
| control | Filter menu |
| platform | ej2-react |
| documentation | ug |
| domainurl |
The filter menu in the React Grid component allows you to enable filtering and provides a user-friendly interface for filtering data based on column types and operators.
To enable the filter menu, you need to set the filterSettings.type property to Menu. This property determines the type of filter UI that will be rendered. The filter menu UI allows you to apply filters using different operators.
Here is an example that demonstrates the usage of the filter menu in the Syncfusion React Grid:
{% tabs %} {% highlight js tabtitle="App.jsx" %} {% include code-snippet/grid/filter-cs4/app/App.jsx %} {% endhighlight %} {% highlight ts tabtitle="App.tsx" %} {% include code-snippet/grid/filter-cs4/app/App.tsx %} {% endhighlight %} {% highlight js tabtitle="datasource.jsx" %} {% include code-snippet/grid/filter-cs4/app/datasource.jsx %} {% endhighlight %} {% highlight ts tabtitle="datasource.tsx" %} {% include code-snippet/grid/filter-cs4/app/datasource.tsx %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/grid/filter-cs4" %}
- allowFiltering must be set as true to enable filter menu.
- By setting allowFiltering as false will prevent filter menu rendering for a particular column.
You can enhance the filtering experience in the Syncfusion React Grid component by customizing the filter menu with custom components. This allows you to replace the default search box with custom components like dropdowns or textboxes. By default, the filter menu provides an autocomplete component for string type columns, a numeric textbox for number type columns, and a dropdown component for boolean type columns, making it easy to search for values.
To customize the filter menu, you can make use of the filter.ui property. This property allows you to integrate your desired custom filter component into a specific column of the Grid. To implement a custom filter UI, you need to define the following functions:
- create: This function is responsible for creating the custom component for the filter.
- write: The write function is used to wire events for the custom component. This allows you to handle changes in the custom filter UI.
- read: The read function is responsible for reading the filter value from the custom component. This is used to retrieve the selected filter value.
For example, you can replace the standard search box in the filter menu with a dropdown component. This enables you to perform filtering operations by selecting values from the dropdown list, rather than manually typing in search queries.
Here is a sample code demonstrating how to render a dropdownlist component for the CustomerID column:
{% tabs %} {% highlight js tabtitle="App.jsx" %} {% include code-snippet/grid/filter-cs5/app/App.jsx %} {% endhighlight %} {% highlight ts tabtitle="App.tsx" %} {% include code-snippet/grid/filter-cs5/app/App.tsx %} {% endhighlight %} {% highlight js tabtitle="datasource.jsx" %} {% include code-snippet/grid/filter-cs5/app/datasource.jsx %} {% endhighlight %} {% highlight ts tabtitle="datasource.tsx" %} {% include code-snippet/grid/filter-cs5/app/datasource.tsx %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/grid/filter-cs5" %}
Default filter input for CustomerID column
Custom dropdown filter for CustomerID column
The Syncfusion React Grid provides a feature to display the time in a 24-hour format in the date or datetime column filter dialog. By default, the filter dialog displays the time in a 12-hour format (AM/PM) for the date or datetime column. However, you can customize the default format by setting the type as dateTime and the format as M/d/y HH:mm. To enable the 24-hour time format in the filter dialog, you need to handle the actionComplete event with requestType as filterafteropen and set the timeFormat of the DateTimepicker to HH:mm.
Here is an example that demonstrates how to show 24 hours time format in filter dialog:
{% tabs %} {% highlight js tabtitle="App.jsx" %} {% include code-snippet/grid/filter-cs6/app/App.jsx %} {% endhighlight %} {% highlight ts tabtitle="App.tsx" %} {% include code-snippet/grid/filter-cs6/app/App.tsx %} {% endhighlight %} {% highlight js tabtitle="datasource.jsx" %} {% include code-snippet/grid/filter-cs6/app/datasource.jsx %} {% endhighlight %} {% highlight ts tabtitle="datasource.tsx" %} {% include code-snippet/grid/filter-cs6/app/datasource.tsx %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/grid/filter-cs6" %}
The Syncfusion React Grid enables you to customize the default filter operator list by utilizing the filterSettings.operators property. This feature allows you to define your own set of operators that will be available in the filter menu. You can customize operators for string, number, date, and boolean data types.
The available options for customization are:
- stringOperator- defines customized string operator list.
- numberOperator - defines customized number operator list.
- dateOperator - defines customized date operator list.
- booleanOperator - defines customized boolean operator list.
Here is an example of how to customize the filter operators list in Syncfusion React Grid:
{% tabs %} {% highlight js tabtitle="App.jsx" %} {% include code-snippet/grid/filter-cs17/app/App.jsx %} {% endhighlight %} {% highlight ts tabtitle="App.tsx" %} {% include code-snippet/grid/filter-cs17/app/App.tsx %} {% endhighlight %} {% highlight js tabtitle="datasource.jsx" %} {% include code-snippet/grid/filter-cs17/app/datasource.jsx %} {% endhighlight %} {% highlight ts tabtitle="datasource.tsx" %} {% include code-snippet/grid/filter-cs17/app/datasource.tsx %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/grid/filter-cs17" %}
The Syncfusion React Grid allows you to perform filtering actions based on multiple keywords, rather than a single keyword, using the filter menu dialog. To enable this feature, you can set filterSettings.type as Menu and render the MultiSelect component as a custom component in the filter menu dialog.
Here is an example that demonstrates how to perform filtering by multiple keywords using the filter menu in the Syncfusion React Grid:
{% tabs %} {% highlight js tabtitle="App.jsx" %} {% include code-snippet/grid/filter-cs7/app/App.jsx %} {% endhighlight %} {% highlight ts tabtitle="App.tsx" %} {% include code-snippet/grid/filter-cs7/app/App.tsx %} {% endhighlight %} {% highlight js tabtitle="datasource.jsx" %} {% include code-snippet/grid/filter-cs7/app/datasource.jsx %} {% endhighlight %} {% highlight ts tabtitle="datasource.tsx" %} {% include code-snippet/grid/filter-cs7/app/datasource.tsx %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/grid/filter-cs7" %}
You have the flexibility to customize the default settings of input components within the menu filter by utilizing the params property within the column definition of filter. This allows you to modify the behavior of specific filter components to better suit your needs.
| Column Type | Default component | Customization | API Reference |
|---|---|---|---|
| String | AutoComplete | Eg: { params: { autofill: false }} | AutoComplete API |
| Number | NumericTextBox | Eg: { params: { showSpinButton: false }} | NumericTextBox API |
| Boolean | DropDownList | Eg: { params: { sortOrder:'Ascending'}} | DropDownList API |
| Date | DatePicker | Eg: { params: { weekNumber: true }} | DatePicker API |
| DateTime | DateTimePicker | Eg: { params: { showClearButton: true }} | DateTimePicker API |
To know more about the feature, refer to the Getting Started documentation and API Reference
In the example provided below, the OrderID and Freight columns are numeric columns. When you open the filter dialog for these columns, you will notice that a NumericTextBox with a spin button is displayed to change or set the filter value. However, using the params property, you can hide the spin button specifically for the OrderID column.
{% tabs %} {% highlight js tabtitle="App.jsx" %} {% include code-snippet/grid/filter-cs18/app/App.jsx %} {% endhighlight %} {% highlight ts tabtitle="App.tsx" %} {% include code-snippet/grid/filter-cs18/app/App.tsx %} {% endhighlight %} {% highlight js tabtitle="datasource.jsx" %} {% include code-snippet/grid/filter-cs18/app/datasource.jsx %} {% endhighlight %} {% highlight ts tabtitle="datasource.tsx" %} {% include code-snippet/grid/filter-cs18/app/datasource.tsx %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/grid/filter-cs18" %}
By default, the AutoComplete component in the filter menu dialog is set to automatically fill suggestions as you type. However, there might be scenarios where you want to prevent this autofill behavior to provide a more customized and controlled user experience.
You can prevent autofill feature by setting the autofill parameter to false using the params property within the column definition of the filter.
{% tabs %} {% highlight js tabtitle="App.jsx" %} {% include code-snippet/grid/filter-cs19/app/App.jsx %} {% endhighlight %} {% highlight ts tabtitle="App.tsx" %} {% include code-snippet/grid/filter-cs19/app/App.tsx %} {% endhighlight %} {% highlight js tabtitle="datasource.jsx" %} {% include code-snippet/grid/filter-cs19/app/datasource.jsx %} {% endhighlight %} {% highlight ts tabtitle="datasource.tsx" %} {% include code-snippet/grid/filter-cs19/app/datasource.tsx %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/grid/filter-cs19" %}
When performing filtering programmatically using methods in the Syncfusion React Grid component, you may want to hide the default filter icons to provide a simpler interface.
To customize the filter icon in the Grid, use the display property of the filtermenu as mentioned below
.e-filtermenudiv.e-icons.e-icon-filter {
display: none;
}The following example demonstrate how to hide the default filter icons while filtering the CustomerID column programmatically using a method.
{% tabs %} {% highlight js tabtitle="App.jsx" %} {% raw %} import { ColumnDirective, ColumnsDirective } from '@syncfusion/ej2-react-grids'; import { Filter, GridComponent, Inject } from '@syncfusion/ej2-react-grids'; import { ButtonComponent } from '@syncfusion/ej2-react-buttons'; import * as React from 'react'; import { data } from './datasource'; function App() { let grid; const FilterOptions = { type: 'Menu' }; function btnClick(args) { if(args.currentTarget.id === 'performFilter'){ grid.filterByColumn('CustomerID', 'startswith', 'v'); } else{ grid.clearFiltering() } } return (
{% endraw %} {% endhighlight %} {% highlight ts tabtitle="App.tsx" %} {% raw %} import { ColumnDirective, ColumnsDirective } from '@syncfusion/ej2-react-grids'; import { Filter, GridComponent, Inject } from '@syncfusion/ej2-react-grids'; import { ButtonComponent } from '@syncfusion/ej2-react-buttons'; import * as React from 'react'; import { data } from './datasource'; function App() { let grid; const FilterOptions = { type: 'Menu' }; function btnClick(args) { if(args.currentTarget.id === 'performFilter'){ grid.filterByColumn('CustomerID', 'startswith', 'v'); } else{ grid.clearFiltering() } } return (
{% previewsample "page.domainurl/code-snippet/grid/filter-method" %}
The Syncfusion React Grid offers the actionBegin and actionComplete events, which provide information about the actions being performed. Within the event handlers, you receive an argument named requestType. This argument specifies the action that is being executed, such as filterbeforeopen, filterafteropen, or filtering. By analyzing this action type, you can implement custom logic or showcase messages.
filtering - Defines current action as filtering. filterbeforeopen - Defines current action as filter dialog before open. filterafteropen - Defines current action as filter dialog after open.
Here's an example of how to use these events to handle filter menu action in the Syncfusion React Grid:
{% tabs %} {% highlight js tabtitle="App.jsx" %} {% include code-snippet/grid/filter-cs11/app/App.jsx %} {% endhighlight %} {% highlight ts tabtitle="App.tsx" %} {% include code-snippet/grid/filter-cs11/app/App.tsx %} {% endhighlight %} {% highlight js tabtitle="datasource.jsx" %} {% include code-snippet/grid/filter-cs11/app/datasource.jsx %} {% endhighlight %} {% highlight ts tabtitle="datasource.tsx" %} {% include code-snippet/grid/filter-cs11/app/datasource.tsx %} {% endhighlight %} {% endtabs %}
{% previewsample "page.domainurl/code-snippet/grid/filter-cs11" %}
When using the filter menu, the UI displays operators for all columns based on the data type of the first data it encounters. If the first data is empty or null, it may not work correctly. To overcome this issue, follow these steps to troubleshoot and resolve it:
Explicitly Define Data Type: When defining ColumnDirective in your React Grid component, make sure to explicitly specify the data type for each column. You can do this using the type property within the columns configuration. For example:
<GridComponent dataSource={data}>
<ColumnsDirective>
<ColumnDirective field='OrderID' headerText='Order ID' type='number' width='140' textAlign="Right"/>
<ColumnDirective field='CustomerID' headerText='Customer ID' type='string' width='140' />
<!-- Define data types for other columns as needed -->
</ColumnsDirective>
</GridComponent>Handle Null or Empty Data: If your data source contains null or empty values, make sure that these values are appropriately handled within your data source or by preprocessing your data to ensure consistency.
Check Data Types in Data Source: Ensure that the data types specified in the column definitions match the actual data types in your data source. Mismatched data types can lead to unexpected behavior.