DevExtreme jQuery - Configure Search Parameters
The TagBox widget allows an end user to search through its items. This feature is disabled by default. To enable it, assign true to the searchEnabled option. Use the searchExpr option to specify which data fields should be searched. Assign an array of field names to this option if you need to search several fields.
jQuery
var tagBoxData = [
{ id: 1, country: "Afghanistan", capital: "Kabul" },
{ id: 2, country: "Albania", capital: "Tirana" },
// ...
];
$(function() {
$("#tagBoxContainer").dxTagBox({
dataSource: tagBoxData,
valueExpr: 'id',
displayExpr: 'country',
searchEnabled: true,
searchExpr: ['capital', 'country']
});
});Angular
<dx-tag-box
[dataSource]="tagBoxData"
valueExpr="id"
displayExpr="country"
[searchEnabled]="true"
[searchExpr]="['country', 'capital']">
</dx-tag-box>
import { DxTagBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
tagBoxData = [
{ id: 1, country: "Afghanistan", capital: "Kabul" },
{ id: 2, country: "Albania", capital: "Tirana" },
// ...
];
}
@NgModule({
imports: [
// ...
DxTagBoxModule
],
// ...
})When a user types a string in the input field, the TagBox suggests all items that contain this string. Assign 'startswith' to the searchMode option if you want the TagBox to suggest only those items that start with the input string.
jQuery
$(function() {
$("#tagBoxContainer").dxTagBox({
dataSource: tagBoxData,
valueExpr: 'id',
displayExpr: 'country',
searchEnabled: true,
searchExpr: 'country',
searchMode: 'startswith'
});
});Angular
<dx-tag-box
[dataSource]="tagBoxData"
valueExpr="id"
displayExpr="country"
[searchEnabled]="true"
searchExpr="country"
searchMode="startswith">
</dx-tag-box>
import { DxTagBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
tagBoxData = [
{ id: 1, country: "Afghanistan", capital: "Kabul" },
{ id: 2, country: "Albania", capital: "Tirana" },
// ...
];
}
@NgModule({
imports: [
// ...
DxTagBoxModule
],
// ...
})There is a delay between the moment a user finishes typing and the moment the search is executed. To increase or descrease it, use the searchTimeout option. The delay is measured in milliseconds.
jQuery
$(function() {
$("#tagBoxContainer").dxTagBox({
dataSource: tagBoxData,
valueExpr: 'id',
displayExpr: 'country',
searchEnabled: true,
searchExpr: 'country',
searchTimeout: 1000
});
});Angular
<dx-tag-box
[dataSource]="tagBoxData"
valueExpr="id"
displayExpr="country"
[searchEnabled]="true"
searchExpr="country"
[searchTimeout]="1000">
</dx-tag-box>
import { DxTagBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
tagBoxData = [
{ id: 1, country: "Afghanistan", capital: "Kabul" },
{ id: 2, country: "Albania", capital: "Tirana" },
// ...
];
}
@NgModule({
imports: [
// ...
DxTagBoxModule
],
// ...
})The TagBox widget starts searching after a user has typed at least one character by default. Use the minSearchLength option to increase the number of characters that triggers the search.
jQuery
$(function() {
$("#tagBoxContainer").dxTagBox({
dataSource: tagBoxData,
valueExpr: 'id',
displayExpr: 'country',
searchEnabled: true,
searchExpr: "country",
minSearchLength: 3
});
});Angular
<dx-tag-box
[dataSource]="tagBoxData"
valueExpr="id"
displayExpr="country"
[searchEnabled]="true"
searchExpr="country"
[minSearchLength]="3">
</dx-tag-box>
import { DxTagBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
tagBoxData = [
{ id: 1, country: "Afghanistan", capital: "Kabul" },
// ...
];
}
@NgModule({
imports: [
// ...
DxTagBoxModule
],
// ...
})