How can I help you?
Filtering in React Combo box component
21 Feb 202624 minutes to read
The ComboBox includes built-in filtering support when allowFiltering is enabled. Filtering begins immediately as you type characters in the input field.
To display filtered items in the popup, handle the filtering event to filter your data source and return results using the updateData method.
The following example shows how to filter the data source and display results through the updateData method in the filtering event.
[Class-component]
// import DataManager related classes
import { Query } from '@syncfusion/ej2-data';
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component {
// define the filtering data
searchData = [
{ Index: "s1", Country: "California" }, { Index: "s2", Country: "Florida" },
{ Index: "s3", Country: "Alaska" }, { Index: "s4", Country: "Georgia" }
];
// maps the appropriate column to fields property
fields = { text: "Country", value: "Index" };
// sort the resulted items
sortOrder = 'Ascending';
constructor(props) {
super(props);
this.onFiltering = this.onFiltering.bind(this);
}
// filtering event handler to filter a Country
onFiltering(args) {
let query = new Query();
// frame the query based on search string with filter type.
query = (args.text !== "") ? query.where("Country", "startswith", args.text, true) : query;
// pass the filter data source, filter query to updateData method.
args.updateData(this.searchData, query);
}
render() {
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" popupHeight="250px" fields={this.fields} filtering={this.onFiltering} allowFiltering={true} sortOrder={this.sortOrder} dataSource={this.searchData} placeholder="Select a country"/>);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));// import DataManager related classes
import { Query } from '@syncfusion/ej2-data';
import { SortOrder } from '@syncfusion/ej2-lists';
import { ComboBoxComponent, FilteringEventArgs } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component<{}, {}> {
// define the filtering data
private searchData: { [key: string]: Object }[] = [
{ Index: "s1", Country: "California" }, { Index: "s2", Country: "Florida" },
{ Index: "s3", Country: "Alaska" }, { Index: "s4", Country: "Georgia" }
];
// maps the appropriate column to fields property
private fields: object = { text: "Country", value: "Index" };
// sort the resulted items
private sortOrder: SortOrder = 'Ascending';
constructor(props: any) {
super(props);
this.onFiltering = this.onFiltering.bind(this);
}
// filtering event handler to filter a Country
public onFiltering(args: FilteringEventArgs) {
let query = new Query();
// frame the query based on search string with filter type.
query = (args.text !== "") ? query.where("Country", "startswith", args.text, true) : query;
// pass the filter data source, filter query to updateData method.
args.updateData(this.searchData, query);
}
public render() {
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" popupHeight="250px" fields={this.fields} filtering={this.onFiltering} allowFiltering={true} sortOrder={this.sortOrder} dataSource={this.searchData} placeholder="Select a country" />
);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));[Functional-component]
// import DataManager related classes
import { Query } from '@syncfusion/ej2-data';
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App() {
// define the filtering data
const searchData = [
{ Index: "s1", Country: "California" }, { Index: "s2", Country: "Florida" },
{ Index: "s3", Country: "Alaska" }, { Index: "s4", Country: "Georgia" }
];
// maps the appropriate column to fields property
const fields = { text: "Country", value: "Index" };
// sort the resulted items
const sortOrder = 'Ascending';
// filtering event handler to filter a Country
function onFiltering(args) {
let query = new Query();
// frame the query based on search string with filter type.
query = (args.text !== "") ? query.where("Country", "startswith", args.text, true) : query;
// pass the filter data source, filter query to updateData method.
args.updateData(this.searchData, query);
}
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" popupHeight="250px" fields={fields} filtering={onFiltering} allowFiltering={true} sortOrder={sortOrder} dataSource={searchData} placeholder="Select a country"/>);
}
ReactDOM.render(<App />, document.getElementById('sample'));// import DataManager related classes
import { Query } from '@syncfusion/ej2-data';
import { SortOrder } from '@syncfusion/ej2-lists';
import { ComboBoxComponent, FilteringEventArgs } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App() {
// define the filtering data
const searchData: { [key: string]: Object }[] = [
{ Index: "s1", Country: "California" }, { Index: "s2", Country: "Florida" },
{ Index: "s3", Country: "Alaska" }, { Index: "s4", Country: "Georgia" }
];
// maps the appropriate column to fields property
const fields: object = { text: "Country", value: "Index" };
// sort the resulted items
const sortOrder: SortOrder = 'Ascending';
// filtering event handler to filter a Country
function onFiltering(args: FilteringEventArgs) {
let query = new Query();
// frame the query based on search string with filter type.
query = (args.text !== "") ? query.where("Country", "startswith", args.text, true) : query;
// pass the filter data source, filter query to updateData method.
args.updateData(this.searchData, query);
}
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" popupHeight="250px" fields={fields} filtering={onFiltering} allowFiltering={true} sortOrder={sortOrder} dataSource={searchData} placeholder="Select a country" />
);
}
ReactDOM.render(<App />, document.getElementById('sample'));Limit the minimum filter character
Control filtering performance by setting a minimum character count before issuing remote requests. Use manual validation in the filter event handler to enforce this limit.
In the following example, the component does not fetch data until at least three characters are typed.
[Class-component]
import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component {
// bind the DataManager instance to dataSource property
searchData = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
fields = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
sortOrder = 'Ascending';
constructor(props) {
super(props);
this.onFiltering = this.onFiltering.bind(this);
}
// filtering event handler to filter a customer
onFiltering(e) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
}
else {
// restrict the remote request until search key contains 3 characters.
if (e.text.length < 3) {
return;
}
let query = new Query().select(['ContactName', 'CustomerID']);
query = (e.text !== '') ? query.where('ContactName', 'startswith', e.text, true) : query;
e.updateData(this.searchData, query);
}
}
render() {
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" allowFiltering={true} popupHeight="250px" filtering={this.onFiltering} query={this.query} dataSource={this.searchData} fields={this.fields} placeholder="Select a customer" sortOrder={this.sortOrder}/>);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { SortOrder } from '@syncfusion/ej2-lists';
import { ComboBoxComponent, FilteringEventArgs } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component<{}, {}> {
// bind the DataManager instance to dataSource property
private searchData: DataManager = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
private fields: object = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
private query: Query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
private sortOrder: SortOrder = 'Ascending';
constructor(props: any) {
super(props);
this.onFiltering = this.onFiltering.bind(this);
}
// filtering event handler to filter a customer
public onFiltering(e: FilteringEventArgs) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
} else {
// restrict the remote request until search key contains 3 characters.
if (e.text.length < 3) { return; }
let query: Query = new Query().select(['ContactName', 'CustomerID']);
query = (e.text !== '') ? query.where('ContactName', 'startswith', e.text, true) : query;
e.updateData(this.searchData, query);
}
}
public render() {
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" allowFiltering={true} popupHeight="250px" filtering={this.onFiltering} query={this.query} dataSource={this.searchData} fields={this.fields} placeholder="Select a customer" sortOrder={this.sortOrder} />
);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));[Functional-component]
import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App() {
// bind the DataManager instance to dataSource property
const searchData = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
const fields = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
const query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
const sortOrder = 'Ascending';
// filtering event handler to filter a customer
function onFiltering(e) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
}
else {
// restrict the remote request until search key contains 3 characters.
if (e.text.length < 3) {
return;
}
let query = new Query().select(['ContactName', 'CustomerID']);
query = (e.text !== '') ? query.where('ContactName', 'startswith', e.text, true) : query;
e.updateData(this.searchData, query);
}
}
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" allowFiltering={true} popupHeight="250px" filtering={onFiltering} query={query} dataSource={searchData} fields={fields} placeholder="Select a customer" sortOrder={sortOrder}/>);
}
ReactDOM.render(<App />, document.getElementById('sample'));import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { SortOrder } from '@syncfusion/ej2-lists';
import { ComboBoxComponent, FilteringEventArgs } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App() {
// bind the DataManager instance to dataSource property
const searchData: DataManager = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
const fields: object = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
const query: Query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
const sortOrder: SortOrder = 'Ascending';
// filtering event handler to filter a customer
function onFiltering(e: FilteringEventArgs) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
} else {
// restrict the remote request until search key contains 3 characters.
if (e.text.length < 3) { return; }
let query: Query = new Query().select(['ContactName', 'CustomerID']);
query = (e.text !== '') ? query.where('ContactName', 'startswith', e.text, true) : query;
e.updateData(this.searchData, query);
}
}
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" allowFiltering={true} popupHeight="250px" filtering={onFiltering} query={query} dataSource={searchData} fields={fields} placeholder="Select a customer" sortOrder={sortOrder} />
);
}
ReactDOM.render(<App />, document.getElementById('sample'));Change the filter type
Customize filter behavior by changing the filter type to contains, startsWith, or endsWith within the filter event handler.
The following examples demonstrate filtering with the endsWith type.
[Class-component]
// import DataManager related classes
import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component {
// bind the DataManager instance to dataSource property
searchData = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
fields = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
sortOrder = 'Ascending';
constructor(props) {
super(props);
this.onFiltering = this.onFiltering.bind(this);
}
// filtering event handler to filter a customer
onFiltering(e) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
}
else {
let query = new Query().select(["ContactName", "CustomerID"]);
query = (e.text !== '') ? query.where('ContactName', 'endswith', e.text, true) : query;
e.updateData(this.searchData, query);
}
}
render() {
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" allowFiltering={true} popupHeight="250px" filtering={this.onFiltering} query={this.query} dataSource={this.searchData} fields={this.fields} placeholder="Select a customer" sortOrder={this.sortOrder}/>);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));// import DataManager related classes
import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { SortOrder } from '@syncfusion/ej2-lists';
import { ComboBoxComponent, FilteringEventArgs } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component<{}, {}> {
// bind the DataManager instance to dataSource property
private searchData: DataManager = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
private fields: object = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
private query: Query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
private sortOrder: SortOrder = 'Ascending';
constructor(props: any) {
super(props);
this.onFiltering = this.onFiltering.bind(this);
}
// filtering event handler to filter a customer
public onFiltering(e: FilteringEventArgs) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
} else {
let query: Query = new Query().select(["ContactName", "CustomerID"]);
query = (e.text !== '') ? query.where('ContactName', 'endswith', e.text, true) : query;
e.updateData(this.searchData, query);
}
}
public render() {
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" allowFiltering={true} popupHeight="250px" filtering={this.onFiltering} query={this.query} dataSource={this.searchData} fields={this.fields} placeholder="Select a customer" sortOrder={this.sortOrder} />
);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));[Functional-component]
// import DataManager related classes
import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App() {
// bind the DataManager instance to dataSource property
const searchData = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
const fields = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
const query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
const sortOrder = 'Ascending';
// filtering event handler to filter a customer
function onFiltering(e) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
}
else {
let query = new Query().select(["ContactName", "CustomerID"]);
query = (e.text !== '') ? query.where('ContactName', 'endswith', e.text, true) : query;
e.updateData(this.searchData, query);
}
}
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" allowFiltering={true} popupHeight="250px" filtering={onFiltering} query={query} dataSource={searchData} fields={fields} placeholder="Select a customer" sortOrder={sortOrder}/>);
}
ReactDOM.render(<App />, document.getElementById('sample'));// import DataManager related classes
import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { SortOrder } from '@syncfusion/ej2-lists';
import { ComboBoxComponent, FilteringEventArgs } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App(){
// bind the DataManager instance to dataSource property
const searchData: DataManager = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
const fields: object = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
const query: Query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
const sortOrder: SortOrder = 'Ascending';
// filtering event handler to filter a customer
function onFiltering(e: FilteringEventArgs) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
} else {
let query: Query = new Query().select(["ContactName", "CustomerID"]);
query = (e.text !== '') ? query.where('ContactName', 'endswith', e.text, true) : query;
e.updateData(this.searchData, query);
}
}
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" allowFiltering={true} popupHeight="250px" filtering={onFiltering} query={query} dataSource={searchData} fields={fields} placeholder="Select a customer" sortOrder={sortOrder} />
);
}
ReactDOM.render(<App />, document.getElementById('sample'));Case sensitive filtering
Data items can be filtered either with or without case sensitivity using the DataManager. This can be done by passing the fourth optional parameter of the where clause.
The following example shows how to perform case-sensitive filter.
[Class-component]
import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component {
// bind the DataManager instance to dataSource property
searchData = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
fields = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
sortOrder = 'Ascending';
constructor(props) {
super(props);
this.onFiltering = this.onFiltering.bind(this);
}
// filtering event handler to filter a customer
onFiltering(e) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
}
else {
let query = new Query().select(["ContactName", "CustomerID"]);
// enable the case sensitive filtering by passing false to 4th parameter.
query = (e.text !== '') ? query.where('ContactName', 'contains', e.text, false) : query;
e.updateData(this.searchData, query);
}
}
render() {
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" popupHeight="250px" allowFiltering={true} filtering={this.onFiltering} query={this.query} dataSource={this.searchData} fields={this.fields} placeholder="Select a customer" sortOrder={this.sortOrder}/>);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { SortOrder } from '@syncfusion/ej2-lists';
import { ComboBoxComponent, FilteringEventArgs } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component<{}, {}> {
// bind the DataManager instance to dataSource property
private searchData: DataManager = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
private fields: object = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
private query: Query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
private sortOrder: SortOrder = 'Ascending';
constructor(props: any) {
super(props);
this.onFiltering = this.onFiltering.bind(this);
}
// filtering event handler to filter a customer
public onFiltering(e: FilteringEventArgs) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
} else {
let query: Query = new Query().select(["ContactName", "CustomerID"]);
// enable the case sensitive filtering by passing false to 4th parameter.
query = (e.text !== '') ? query.where('ContactName', 'contains', e.text, false) : query;
e.updateData(this.searchData, query);
}
}
public render() {
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" popupHeight="250px" allowFiltering={true} filtering={this.onFiltering} query={this.query} dataSource={this.searchData} fields={this.fields} placeholder="Select a customer" sortOrder={this.sortOrder} />
);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));[Functional-component]
import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App() {
// bind the DataManager instance to dataSource property
const searchData = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
const fields = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
const query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
const sortOrder = 'Ascending';
// filtering event handler to filter a customer
function onFiltering(e) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
}
else {
let query = new Query().select(["ContactName", "CustomerID"]);
// enable the case sensitive filtering by passing false to 4th parameter.
query = (e.text !== '') ? query.where('ContactName', 'contains', e.text, false) : query;
e.updateData(this.searchData, query);
}
}
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" popupHeight="250px" allowFiltering={true} filtering={onFiltering} query={query} dataSource={searchData} fields={fields} placeholder="Select a customer" sortOrder={sortOrder}/>);
}
ReactDOM.render(<App />, document.getElementById('sample'));import { DataManager, ODataV4Adaptor, Query } from '@syncfusion/ej2-data';
import { SortOrder } from '@syncfusion/ej2-lists';
import { ComboBoxComponent, FilteringEventArgs } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App() {
// bind the DataManager instance to dataSource property
const searchData: DataManager = new DataManager({
adaptor: new ODataV4Adaptor,
crossDomain: true,
url: 'https://services.odata.org/V4/Northwind/Northwind.svc/Customers'
});
// maps the appropriate column to fields property
const fields: object = { text: 'ContactName', value: 'CustomerID' };
// bind the Query instance to query property
const query: Query = new Query().select(['ContactName', 'CustomerID']).take(6);
// sort the resulted items
const sortOrder: SortOrder = 'Ascending';
// filtering event handler to filter a customer
function onFiltering(e: FilteringEventArgs) {
// load overall data when search key empty.
if (e.text === '') {
e.updateData(this.searchData);
} else {
let query: Query = new Query().select(["ContactName", "CustomerID"]);
// enable the case sensitive filtering by passing false to 4th parameter.
query = (e.text !== '') ? query.where('ContactName', 'contains', e.text, false) : query;
e.updateData(this.searchData, query);
}
}
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" popupHeight="250px" allowFiltering={true} filtering={onFiltering} query={query} dataSource={searchData} fields={fields} placeholder="Select a customer" sortOrder={sortOrder} />
);
}
ReactDOM.render(<App />, document.getElementById('sample'));Diacritics Filtering
The ComboBox supports diacritics filtering, which ignores diacritics to simplify filtering international character lists when the ignoreAccent property is enabled.
In the following example, data with diacritics is bound as the dataSource for the ComboBox.
[Class-component]
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component {
diacriticsData = [
'Aeróbics',
'Aeróbics en Agua',
'Aerografía',
'Aeromodelaje',
'Águilas',
'Ajedrez',
'Ala Delta',
'Álbumes de Música',
'Alusivos',
'Análisis de Escritura a Mano'
];
render() {
return (<ComboBoxComponent id="diacritics" ignoreAccent={true} allowFiltering={true} dataSource={this.diacriticsData} placeholder="e.g: aero"/>);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component<{}, {}> {
private diacriticsData: string[] = [
'Aeróbics',
'Aeróbics en Agua',
'Aerografía',
'Aeromodelaje',
'Águilas',
'Ajedrez',
'Ala Delta',
'Álbumes de Música',
'Alusivos',
'Análisis de Escritura a Mano'];
public render() {
return (
<ComboBoxComponent id="diacritics" ignoreAccent={true} allowFiltering={true} dataSource={this.diacriticsData} placeholder="e.g: aero" />
);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));[Functional-component]
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App() {
const diacriticsData = [
'Aeróbics',
'Aeróbics en Agua',
'Aerografía',
'Aeromodelaje',
'Águilas',
'Ajedrez',
'Ala Delta',
'Álbumes de Música',
'Alusivos',
'Análisis de Escritura a Mano'
];
return (<ComboBoxComponent id="diacritics" ignoreAccent={true} allowFiltering={true} dataSource={diacriticsData} placeholder="e.g: aero"/>);
}
ReactDOM.render(<App />, document.getElementById('sample'));import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App() {
const diacriticsData: string[] = [
'Aeróbics',
'Aeróbics en Agua',
'Aerografía',
'Aeromodelaje',
'Águilas',
'Ajedrez',
'Ala Delta',
'Álbumes de Música',
'Alusivos',
'Análisis de Escritura a Mano'];
return (
<ComboBoxComponent id="diacritics" ignoreAccent={true} allowFiltering={true} dataSource={diacriticsData} placeholder="e.g: aero" />
);
}
ReactDOM.render(<App />, document.getElementById('sample'));Debounce delay
You can use the debounceDelay property for filtering, enabling you to set a delay in milliseconds. This functionality helps reduce the frequency of filtering as you type, enhancing performance and responsiveness for a smoother user experience.By default, a DebounceDelay of 300ms is set. If you wish to disable this feature entirely, you can set it to 0ms.
[Class-component]
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component {
// define the array of string
sportsData = ['Badminton', 'Basketball', 'Cricket', 'Football', 'Golf', 'Hockey', 'Snooker', 'Tennis'];
render() {
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" dataSource={this.sportsData} placeholder="Select a game" debounceDelay={300}/>);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
export default class App extends React.Component<{}, {}> {
// define the array of string
private sportsData: string[] = ['Badminton', 'Basketball', 'Cricket', 'Football', 'Golf', 'Hockey', 'Snooker', 'Tennis'];
public render() {
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" dataSource={this.sportsData} placeholder="Select a game" debounceDelay={300}/>
);
}
}
ReactDOM.render(<App />, document.getElementById('sample'));[Functional-component]
import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App() {
// define the array of string
const sportsData = ['Badminton', 'Basketball', 'Cricket', 'Football', 'Golf', 'Hockey', 'Snooker', 'Tennis'];
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" dataSource={sportsData} placeholder="Select a game" debounceDelay={300}/>);
}
ReactDOM.render(<App />, document.getElementById('sample'));import { ComboBoxComponent } from '@syncfusion/ej2-react-dropdowns';
import * as React from 'react';
import * as ReactDOM from 'react-dom';
function App() {
// define the array of string
const sportsData: string[] = ['Badminton', 'Basketball', 'Cricket', 'Football', 'Golf', 'Hockey', 'Snooker', 'Tennis'];
return (
// specifies the tag for render the ComboBox component
<ComboBoxComponent id="comboelement" dataSource={sportsData} placeholder="Select a game" debounceDelay={300} />
);
}
ReactDOM.render(<App />, document.getElementById('sample'));