jQuery SelectBox - Create a User-Defined Item
A user can select existing values and add new values to the SelectBox. To enable this feature, assign true to the acceptCustomValue property.
Note that you should implement the onCustomItemCreating function to create a new data source entry. You can specify DOM events after which the component calls this function. Use the customItemCreateEvent property for this purpose. In addition to the event passed to this property, the item can also be created when users press the Enter key.
jQuery
HTML
JavaScript
<div id="selectBoxContainer"></div>
const selectBoxData = new DevExpress.data.DataSource({
store: [
{ id: 1, firstName: "Andrew" },
{ id: 2, firstName: "Nancy" },
{ id: 3, firstName: "Steven" }
]
});
$(function() {
$("#selectBoxContainer").dxSelectBox({
dataSource: selectBoxData,
valueExpr: 'id',
displayExpr: 'firstName',
acceptCustomValue: true,
customItemCreateEvent: 'focusout',
onCustomItemCreating: function(e) {
// Generates a new 'id'
let nextId;
selectBoxData.store().totalCount().done(count => {nextId = count + 1});
// Creates a new entry
e.customItem = { id: nextId, firstName: e.text };
// Adds the entry to the data source
selectBoxData.store().insert(e.customItem);
// Reloads the data source
selectBoxData.reload();
}
});
});Angular
TypeScript
HTML
import DataSource from "devextreme/data/data_source";
import { DxSelectBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
selectBoxData = new DataSource({
store: [
{ id: 1, firstName: "Andrew" },
{ id: 2, firstName: "Nancy" },
{ id: 3, firstName: "Steven" }
]
});
onCustomItemCreating (e) {
// Generates a new 'id'
let nextId;
selectBoxData.store().totalCount().done(count => {nextId = count + 1});
// Creates a new entry
e.customItem = { id: nextId, firstName: e.text };
// Adds the entry to the data source
this.selectBoxData.store().insert(e.customItem);
// Reloads the data source
this.selectBoxData.reload();
}
}
@NgModule({
imports: [
// ...
DxSelectBoxModule
],
// ...
})
<dx-select-box
[dataSource]="selectBoxData"
valueExpr="id"
displayExpr="firstName"
[acceptCustomValue]="true"
customItemCreateEvent="focusout"
(onCustomItemCreating)="onCustomItemCreating($event)">
</dx-select-box>Vue
App.vue
<template>
<DxSelectBox ...
:data-source="selectBoxData"
:accept-custom-value="true"
display-expr="firstName"
value-expr="id"
custom-item-create-event="focusout"
@custom-item-creating="customItemCreating"
/>
</template>
<script>
import 'devextreme/dist/css/dx.light.css';
import { DxSelectBox } from 'devextreme-vue/select-box';
import DataSource from "devextreme/data/data_source";
const selectBoxData = new DataSource({
store: [
{ id: 1, firstName: "Andrew" },
{ id: 2, firstName: "Nancy" },
{ id: 3, firstName: "Steven" }
],
key: "id"
});
export default {
components: {
DxSelectBox
},
data() {
return {
selectBoxData
}
}
methods: {
customItemCreating(e) {
// Generates a new 'id'
let nextId;
selectBoxData.store().totalCount().done(count => {nextId = count + 1});
// Creates a new entry
e.customItem = { id: nextId, firstName: e.text };
// Adds the entry to the data source
selectBoxData.store().insert(e.customItem);
// Reloads the data source
selectBoxData.reload();
}
}
}
</script>React
App.js
import React from 'react';
import 'devextreme/dist/css/dx.light.css';
import SelectBox from 'devextreme-react/select-box';
import DataSource from "devextreme/data/data_source";
const selectBoxData = new DataSource({
store: [
{ id: 1, firstName: "Andrew" },
{ id: 2, firstName: "Nancy" },
{ id: 3, firstName: "Steven" }
],
key: "id"
});
class App extends React.Component {
customItemCreating(e) {
// Generates a new 'id'
let nextId;
selectBoxData.store().totalCount().done(count => {nextId = count + 1});
// Creates a new entry
e.customItem = { id: nextId, firstName: e.text };
// Adds the entry to the data source
selectBoxData.store().insert(e.customItem);
// Reloads the data source
selectBoxData.reload();
}
render() {
return (
<SelectBox ...
dataSource={selectBoxData}
valueExpr="id"
displayExpr="firstName"
acceptCustomValue={true}
customItemCreateEvent="focusout"
onCustomItemCreating={this.customItemCreating}
/>
);
}
}
export default App;See Also
Feedback