Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from https://js.devexpress.com/Vue/Documentation/ApiReference/UI_Components/dxSelectBox/Configuration/ below:

Vue SelectBox Props | Vue Documentation

An object defining configuration properties for the SelectBox UI component.

Specifies whether the UI component allows a user to enter a custom value. Requires the onCustomItemCreating handler implementation.

Selector: accept-custom-value

Default Value: false

Specifies the shortcut key that sets focus on the UI component.

Selector: access-key

Default Value: undefined

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

Specifies whether the UI component changes its visual state as a result of user interaction.

Selector: active-state-enabled

Default Value: true

The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.

Use this property when you display the component on a platform whose guidelines include the active state change for UI components.

Allows you to add custom buttons to the input text field.

Selector: DxButton

Default Value: undefined

Built-in buttons should also be declared in this array. You can find an example in the following demo:

View Demo

Specifies the DOM event after which the custom item should be created. Applies only if acceptCustomValue is enabled.

Selector: custom-item-create-event

Default Value: 'change'

This property accepts a single event name or several names separated by spaces.

The recommended events are "blur", "change", and "focusout", but you can use other events as well. The default value of this property is "change", and items are created when the component loses focus.

If you want to enable custom item creation when users press the Tab key, assign "change" or "focusout" to this property.

Besides the event passed to this property, the item can also be created when users press the Enter key. To allow users to create items only when they press the Enter key, pass an empty string to this property.

Binds the UI component to data.

Selector: data-source

Default Value: null

The SelectBox works with collections of objects or string, number, or boolean values.

Depending on your data source, bind SelectBox to data as follows. In each case, also specify the valueExpr, displayExpr, or both if the data source provides objects.

• Data Array
  Assign the array to the dataSource option.

• Read-Only Data in JSON Format
  Set the dataSource property to the URL of a JSON file or service that returns JSON data.

• OData
  Implement an ODataStore.

• Web API, PHP, MongoDB
  Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

  Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

  jQuery

  $(function() {
      let serviceUrl = "https://url/to/my/service";
      $("#selectBoxContainer").dxSelectBox({
          // ...
          dataSource: DevExpress.data.AspNet.createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      })
  });

  Angular

  import { Component } from '@angular/core';
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      store: CustomStore;
      constructor() {
          let serviceUrl = "https://url/to/my/service";
          this.store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      }
  }

  <dx-select-box ...
      [dataSource]="store">
  </dx-select-box>

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxSelectBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxSelectBoxModule
      ],
      providers: [],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  <template> 
      <DxSelectBox ...
          :data-source="store" />
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import { DxSelectBox } from 'devextreme-vue/select-box';
  
  export default {
      components: {
          DxSelectBox
      },
      data() {
          const serviceUrl = "https://url/to/my/service";
          const store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          });
          return {
              store
          }
      }
  }
  </script>

  React

  import React from 'react';
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import SelectBox from 'devextreme-react/select-box';
  
  const serviceUrl = "https://url/to/my/service";
  const store = createStore({
      key: "ID",
      loadUrl: serviceUrl + "/GetAction",
      insertUrl: serviceUrl + "/InsertAction",
      updateUrl: serviceUrl + "/UpdateAction",
      deleteUrl: serviceUrl + "/DeleteAction"
  });
  
  class App extends React.Component {
      render() {
          return (
              <SelectBox ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the SelectBox always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

Review the following notes about data binding:

• Do not specify the items property if you specified the dataSource, and vice versa.

• Field names cannot be equal to this and should not contain the following characters: ., :, [, and ].

• SelectBox does not execute dataSource.sort functions. To implement custom sorting logic, implement columns[].calculateSortValue.

• The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Get and Set Properties.

• The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.

• The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Two-Way Property Binding.

• The stores are immutable. You cannot change their configurations at runtime. Instead, create a new store or DataSource and assign it to the dataSource property as shown in the following help topic: Controlled Mode.

View Demo

Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately.

Selector: defer-rendering

Default Value: true

If you set the deferRendering property to true, wrap the content in the Angular named template.

If you set the deferRendering property to true, wrap the content in the Vue named template.

Specifies whether the UI component responds to user interaction.

View Demo

Specifies the data field whose values should be displayed.

Selector: display-expr

The current item's data object.

Default Value: undefined

View Demo

Set this property to the name of a data field that provides displayed values...

... or to a function that returns the displayed value:

displayExpr: function(item) {
    // "item" can be null
    return item && 'ID: ' + item.id + ', Name: ' + item.name;
}

Leave this property unspecified or set it to this if the data source contains primitives.

• valueExpr

Returns the value currently displayed by the UI component.

Selector: display-value

Read-only

Default Value: undefined

The value you pass to this property does not affect UI component behavior. Pass an observable variable to this property to get the value currently displayed by the UI component.

Specifies a custom template for the drop-down button.

Selector: drop-down-button-template

String

The button's icon.

String

The button's text.

Default Name: 'dropDownButton'

Configures the drop-down field which holds the content.

Selector: drop-down-options

Default Value: {}

See Popup Configuration for properties that you can specify in this object.

The nested component that configures the dropDownOptions property does not support event bindings and two-way property bindings.

The nested component that configures the dropDownOptions property does not support event bindings and two-way property bindings.

Specifies the global attributes to be attached to the UI component's container element.

Selector: DxElementAttr

Default Value: {}

$(function(){
    $("#selectBoxContainer").dxSelectBox({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

<dx-select-box ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-select-box>

import { DxSelectBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxSelectBoxModule
    ],
    // ...
})

<template>
    <DxSelectBox ...
        :element-attr="selectBoxAttributes">
    </DxSelectBox>
</template>

<script>
import DxSelectBox from 'devextreme-vue/select-box';

export default {
    components: {
        DxSelectBox
    },
    data() {
        return {
            selectBoxAttributes: {
                id: 'elementId',
                class: 'class-name'
            }
        }
    }
}
</script>

import React from 'react';

import SelectBox from 'devextreme-react/select-box';

class App extends React.Component {
    selectBoxAttributes = {
        id: 'elementId',
        class: 'class-name'
    }

    render() {
        return (
            <SelectBox ...
                elementAttr={this.selectBoxAttributes}>
            </SelectBox>
        );
    }
}
export default App;

Specifies a custom template for the text field. Must contain the TextBox UI component.

Selector: field-template

Object

The selected item's data.

Default Name: null

If you define a fieldTemplate, the component does not render the underlying HTML. In this case, you should render hidden input with the corresponding name attribute to submit values through a HTML form.

The example below shows how to define the fieldTemplate. If you want to customize the field's text, use the TextBox's value property.

$(function() {
    $("#selectBox").dxSelectBox({
        // ...
        fieldTemplate(data, container) {
            container.append(
                $('<div>').dxTextBox({
                    value: data.Category + ": " + data.Name,
                    readOnly: true
                })
            )
        },
    });
});

<dx-select-box ...
    fieldTemplate="field"
>
    <div *dxTemplate="let data of 'field'">
        <div>
            <dx-text-box 
                [value]="data && data.Category + ': ' + data.Name" 
                [readOnly]="true"
            >
            </dx-text-box>
        </div>
    </div>
</dx-select-box>

<template>
    <DxSelectBox ...
        field-template="field"
    >
        <template #field="{ data }">
            <DxTextBox 
                :value="data && data.Category + ': ' + data.Name" 
                :read-only="true"
            />
        </template>
    </DxSelectBox>
</template>

<script>
// ...
import DxSelectBox from 'devextreme-vue/select-box';
import DxTextBox from 'devextreme-vue/text-box';

export default {
    components: {
        DxSelectBox,
        DxTextBox
    },
    data() {
        return {
            // ...
        }
    }
}
</script>

import React from "react";
import SelectBox from "devextreme-react/select-box";
import TextBox from "devextreme-react/text-box";

function Field(data) {
    return <TextBox value={data && data.Category + ': ' + data.Name} readOnly={true} />;
}
function App() {
    return (
        <SelectBox ...
            fieldRender={Field}
        />
        </div>
    );
}

export default App;

View Demo

• Customize Item Appearance
• Custom Templates

Specifies whether the UI component can be focused using keyboard navigation.

Selector: focus-state-enabled

Default Value: true

Specifies whether data items should be grouped.

When this property is true, make sure that all data source objects have the following structure:

const dataSource = [{
    key: "Group 1", // Group caption 
    items: [ // Items in the group
        { ... },
        { ... }
    ]
}, {
    // ...
}];

You can supply data to this structure using the DataSource object's group property.

• Only one-level grouping is supported.

• If you enable both this property and DataSource.paginate, the pagination works only on the group level.

SelectBox Demo TagBox Demo

• SelectBox - Grouping
• TagBox - Grouping

Specifies a custom template for group captions.

Selector: group-template

Object

The group's data.

Default Name: 'group'

Specifies the UI component's height.

This property accepts a value of one of the following types:

• Number
  The height in pixels.

• String
  A CSS-accepted measurement of height. For example, "55px", "20vh", "80%", "inherit".

Specifies text for a hint that appears when a user pauses on the UI component.

Specifies whether the UI component changes its state when a user pauses on it.

Selector: hover-state-enabled

Default Value: true

Specifies the attributes to be passed on to the underlying HTML element.

Selector: input-attr

Type: any

Default Value: {}

$(function(){
    $("#selectBoxContainer").dxSelectBox({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});

<dx-select-box ...
    [inputAttr]="{ id: 'inputId' }">
</dx-select-box>

import { DxSelectBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxSelectBoxModule
    ],
    // ...
})

<template>
    <DxSelectBox
        :input-attr="inputAttr"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxSelectBox from 'devextreme-vue/select-box';

export default {
    components: {
        DxSelectBox
    },
    data() {
        return {
            inputAttr: { id: 'inputId' }
        }
    }
}
</script>

import 'devextreme/dist/css/dx.light.css';

import SelectBox from 'devextreme-react/select-box';

const inputAttr = { id: 'inputId' };

export default function App() {
    return (
        <SelectBox
            inputAttr={inputAttr}
        />
    );
}

@(Html.DevExtreme().SelectBox()
    .InputAttr("id", "inputId")
    // ===== or =====
    .InputAttr(new {
        @id = "inputId"
    })
    // ===== or =====
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" }
    })
)

@(Html.DevExtreme().SelectBox() _
    .InputAttr("id", "inputId")
    ' ===== or =====
    .InputAttr(New With {
        .id = "inputId"
    })
    ' ===== or =====
    .InputAttr(New Dictionary(Of String, Object) From {
        { "id", "inputId" }
    })
)

To improve accessibility, use this property to specify aria-label for the component.

$(function(){
    $("#selectBoxContainer").dxSelectBox({
        // ...
        inputAttr: {
            'aria-label': 'your-label',
        },
    });
});

<dx-select-box ...
    [inputAttr]="{ 'aria-label': 'your-label' }">
</dx-select-box>

<template>
    <DxSelectBox
        :input-attr="inputAttr"
    />
</template>

<script>
import DxSelectBox from 'devextreme-vue/select-box';

export default {
    components: {
        DxSelectBox
    },
    data() {
        return {
            inputAttr: { 'aria-label': 'your-label' }
        }
    }
}
</script>

import SelectBox from 'devextreme-react/select-box';

const inputAttr = { 'aria-label': 'your-label' };

export default function App() {
    return (
        <SelectBox
            inputAttr={inputAttr}
        />
    );
}

You do not need to specify aria-label if you use label.

Specifies whether the component's current value differs from the initial value.

Selector: is-dirty

Default Value: false

This property is a read-only flag. You can use it to check if the editor value changed.

$(() => {
    const selectBox = $('#selectBox').dxSelectBox({
        // ...
    }).dxSelectBox('instance');

    $('#button').dxButton({
        // ...
        onClick () {
            if (selectBox.option('isDirty')) {
                DevExpress.ui.notify("Do not forget to save changes", "warning", 500);
            }
        }
    });
});

import { Component, ViewChild } from '@angular/core';
import { DxSelectBoxComponent, DxButtonModule } from 'devextreme-angular';
import notify from 'devextreme/ui/notify';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    @ViewChild('selectBoxRef', { static: false }) selectBox: DxSelectBoxComponent;

    onClick () {
        if (this.selectBox.instance.option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    }
}

<dx-select-box ... 
    #selectBoxRef
>
</dx-select-box>
<dx-button ...
    (onClick)="onClick($event)"
>
</dx-button>

<template>
    <DxSelectBox ...
        :ref="selectBoxRef"
    >
    </DxSelectBox>
    <DxButton ...
        @click="onClick"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';
import DxSelectBox from 'devextreme-vue/select-box';
import DxButton from 'devextreme-vue/button';
import notify from 'devextreme/ui/notify';

export default {
    components: {
        DxSelectBox,
        DxButton
    },

    data() {
        return {
            selectBoxRef
        }
    },

    methods: {
        onClick () {
            if (this.selectBox.option('isDirty')) {
                notify("Do not forget to save changes", "warning", 500);
            }
        }
    },

    computed: {
        selectBox: function() {
            return this.$refs[selectBoxRef].instance;
        }
    }
}
</script>

import React, { useRef } from 'react';
import SelectBox from 'devextreme-react/select-box';
import Button from 'devextreme-react/button';
import 'devextreme/dist/css/dx.light.css';

const App = () => {
    const selectBoxRef = useRef(null);

    const onClick = () => {
        if (this.selectBoxRef.current.instance().option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    };

    return (
        <SelectBox ...
            ref={selectBoxRef}
        >
        </SelectBox>
        <Button ...
            onClick={onClick}
        />
    );
};

export default App;

• reset

Specifies or indicates whether the editor's value is valid.

Selector: is-valid

Default Value: true

An array of items displayed by the UI component.

The items array can contain:

• Objects with fields described in this section
• Objects with any other fields. In this case, specify the itemTemplate.

If you need to update the UI component items, reassign the entire items array as shown in the following example:

selectBoxInstance.option('items', newItems);

As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.

Do not use the items property if you use dataSource, and vice versa.

View Demo

Specifies a custom template for items.

Selector: item-template

Object

The current item's data.

Default Name: 'item'

Specifies a text string used to annotate the editor's value.

Specifies the label's display mode.

Selector: label-mode

Default Value: 'static', 'floating' (Material), 'outside' (Fluent)

This property can have one of the following values:

If autofill is enabled in the browser, we do not recommend that you use "floating" mode. The autofill values will overlap the label when it is displayed as a placeholder. Use "static" mode instead.

Specifies the maximum number of characters you can enter into the textbox.

Selector: max-length

Default Value: null

If the number of entered characters reaches the value assigned to this property, the UI component does not allow you to enter any more characters.

The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true.

Selector: min-search-length

Default Value: 0

When the SelectBox input field contains text (an item is selected), the component ignores minSearchLength and starts searching after users enter one character.

View Demo

• showDataBeforeSearch

The value to be assigned to the name attribute of the underlying HTML element.

Specify this property if the UI component lies within an HTML form that will be submitted.

Specifies the text or HTML markup displayed by the UI component if the item collection is empty.

Selector: no-data-text

Default Value: 'No data to display'

The SelectBox component evaluates the noDataText property's value. This evaluation, however, makes the SelectBox potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the noDataText property. Refer to the following help topic for more information: Potentially Vulnerable API - noDataText.

A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard.

Selector: @change

Information about the event.

Object structure:

Default Value: null

A function that is executed once the drop-down editor is closed.

Selector: @closed

Information about the event.

Object structure:

Default Value: null

A function that is executed when the UI component is rendered and each time the component is repainted.

Selector: @content-ready

Information about the event.

Object structure:

Default Value: null

A function that is executed when the UI component's input has been copied.

Selector: @copy

Information about the event.

Object structure:

Default Value: null

A function that is executed when a user adds a custom item. Requires acceptCustomValue to be set to true.

Selector: @custom-item-creating

Information about the event.

Object structure:

Default Value: function(e) { if(!e.customItem) { e.customItem = e.text; } }

View Demo

You can specify DOM events after which the component calls this function. Use the customItemCreateEvent property for this purpose. Besides the event passed to this property, the item can also be created when users press the Enter key.

The following code shows how to create custom items when the Space key is pressed:

$(function() {
    $("#select-box").dxSelectBox({
        dataSource: [{ id: 1, text: 'item 1'}],
        acceptCustomValue: true,
        onCustomItemCreating(e) {
            if (!e.text) {
                e.customItem = null; // cancels custom item creation
                return;
            }

            const dataSource = e.component.option('dataSource');
            const itemExists = dataSource.find((item) => item.text === e.text.trim())

            if (itemExists) {
                e.customItem = null;
            } else {
                const newItem = {
                    id: dataSource.length + 1,
                    text: e.text.trim(),
                };

                dataSource.push(newItem);
                e.component.option('dataSource', dataSource);
                e.customItem = newItem;
            }
        },
        onKeyDown(e) {
            if (e.event.code === 'Space') {
                const event = new KeyboardEvent('keydown', { key: 'Enter' });
                e.event.target.dispatchEvent(event);
            }
        }
    });
});

<dx-select-box ...
    [dataSource]="dataSource"
    [acceptCustomValue]="true"
    (onCustomItemCreating)="onCustomItemCreating($event)"
    (onKeyDown)="onKeyDown($event)"
></dx-select-box>

import { DxSelectBoxComponent, type DxSelectBoxTypes } from 'devextreme-angular/ui/select-box';

// ...
export class AppComponent {
    itemsArray = [{ id: 1, text: 'item 1'}];

    onCustomItemCreating(e: DxSelectBoxTypes.CustomItemCreatingEvent) {
        if (!e.text) {
            e.customItem = null; // cancels custom item creation
            return;
        }

        const dataSource = e.component.option('dataSource');
        const itemExists = dataSource.find((item) => item.text === e.text.trim())

        if (itemExists) {
            e.customItem = null;
        } else {
            const newItem = {
                id: dataSource.length + 1,
                text: e.text.trim(),
            };

            dataSource.push(newItem);
            e.component.option('dataSource', dataSource);
            e.customItem = newItem;
        }
    }

    onKeyDown(e: DxSelectBoxTypes.KeyDownEvent) {
        if (e.event.code === 'Space') {
            const event = new KeyboardEvent('keydown', { key: 'Enter' });
            e.event.target.dispatchEvent(event);
        }
    }
}

<script setup lang="ts">
import { DxSelectBox, type DxSelectBoxTypes } from 'devextreme-vue/select-box';

const itemsArray = [{ id: 1, text: 'item 1'}];

function onCustomItemCreating(e: DxSelectBoxTypes.CustomItemCreatingEvent) {
    if (!e.text) {
        e.customItem = null; // cancels custom item creation
        return;
    }

    const dataSource = e.component.option('dataSource');
    const itemExists = dataSource.find((item) => item.text === e.text.trim())

    if (itemExists) {
        e.customItem = null;
    } else {
        const newItem = {
            id: dataSource.length + 1,
            text: e.text.trim(),
        };

        dataSource.push(newItem);
        e.component.option('dataSource', dataSource);
        e.customItem = newItem;
    }
}

function onKeyDown(e: DxSelectBoxTypes.KeyDownEvent) {
    if (e.event.code === 'Space') {
        const event = new KeyboardEvent('keydown', { key: 'Enter' });
        e.event.target.dispatchEvent(event);
    }
}

</script>

<template>
    <DxSelectBox ...
        :data-source="itemsArray"
        :accept-custom-value="true"
        @custom-item-creating="onCustomItemCreating"
        @key-down="onKeyDown"
    />
</template>

import { SelectBox, type SelectBoxTypes } from 'devextreme-react/select-box';

const itemsArray = [{ id: 1, text: 'item 1'}];

function onCustomItemCreating(e: SelectBoxTypes.CustomItemCreatingEvent) {
    if (!e.text) {
        e.customItem = null; // cancels custom item creation
        return;
    }

    const dataSource = e.component.option('dataSource');
    const itemExists = dataSource.find((item) => item.text === e.text.trim())

    if (itemExists) {
        e.customItem = null;
    } else {
        const newItem = {
            id: dataSource.length + 1,
            text: e.text.trim(),
        };

        dataSource.push(newItem);
        e.component.option('dataSource', dataSource);
        e.customItem = newItem;
    }
}

function onKeyDown(e: DxSelectBoxTypes.KeyDownEvent) {
    if (e.event.code === 'Space') {
        const event = new KeyboardEvent('keydown', { key: 'Enter' });
        e.event.target.dispatchEvent(event);
    }
}

function App() {
    return (
        <SelectBox ...
            dataSource={itemsArray}
            acceptCustomValue={true}
            onCustomItemCreating={onCustomItemCreating}
            onKeyDown={onKeyDown}
        />
    );
}

To add custom items without updating the component dataSource, integrate the following onCustomItemCreating implementation:

$(function() {
    $("#selectBox").dxSelectBox({
        // ...
        displayExpr: "Name",
        acceptCustomValue: true,
        onCustomItemCreating(e) {
            e.customItem = { text: e.text };
        }
    })
})

<dx-select-box ...
    displayExpr="Name"
    [acceptCustomValue]="true"
    (onCustomItemCreating)="onCustomItemCreating($event)"
></dx-select-box>

import { DxSelectBoxModule, type DxSelectBoxTypes } from "devextreme-angular/ui/select-box"

// ...
export class App {
    onCustomItemCreating(e: DxSelectBoxTypes.CustomItemCreatingEvent) {
        e.customItem = { text: e.text };
    }
}

<script setup lang="ts">
import { DxSelectBox, type DxSelectBoxTypes } from 'devextreme-vue/select-box';

function onCustomItemCreating(e: DxSelectBoxTypes.CustomItemCreatingEvent) {
    e.customItem = { text: e.text };
}
</script>

<template>
    <DxSelectBox ...
        displayExpr="Name"
        :acceptCustomValue="true"
        :onCustomItemCreating="onCustomItemCreating"
    />
</template>

import { SelectBox, type SelectBoxTypes } from 'devextreme-react/select-box';

function App() {
    function onCustomItemCreating(e: SelectBoxTypes.CustomItemCreatingEvent) {
        e.customItem = { text: e.text };
    }

    return (
        <>
            <SelectBox ...
                displayExpr="Name"
                acceptCustomValue={true}
                onCustomItemCreating={onCustomItemCreating}
            />
        </>
    )
}

• Create a User-Defined Item

A function that is executed when the UI component's input has been cut.

Selector: @cut

Information about the event.

Object structure:

Default Value: null

A function that is executed before the UI component is disposed of.

Selector: @disposing

Information about the event.

Object structure:

Default Value: null

A function that is executed when the Enter key has been pressed while the UI component is focused.

Selector: @enter-key

Information about the event.

Object structure:

Default Value: null

A function that is executed when the UI component gets focus.

Selector: @focus-in

Information about the event.

Object structure:

Default Value: null

A function that is executed when the UI component loses focus.

Selector: @focus-out

Information about the event.

Object structure:

Default Value: null

A function used in JavaScript frameworks to save the UI component instance.

Selector: @initialized

Information about the event.

Object structure:

Default Value: null

<dx-select-box ...
    (onInitialized)="saveInstance($event)">
</dx-select-box>

import { Component } from "@angular/core";
import SelectBox from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    selectBoxInstance: SelectBox;
    saveInstance (e) {
        this.selectBoxInstance = e.component;
    }
}

App.vue (Composition API)

<template>
    <div>
        <DxSelectBox ...
            @initialized="saveInstance">
        </DxSelectBox>
    </div>
</template>

<script>
import DxSelectBox from 'devextreme-vue/select-box';

export default {
    components: {
        DxSelectBox
    },
    data: function() {
        return {
            selectBoxInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.selectBoxInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxSelectBox ...
            @initialized="saveInstance">
        </DxSelectBox>
    </div>
</template>

<script setup>
import DxSelectBox from 'devextreme-vue/select-box';

let selectBoxInstance = null;

const saveInstance = (e) => {
    selectBoxInstance = e.component;
}
</script>

import SelectBox from 'devextreme-react/select-box';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.selectBoxInstance = e.component;
    }

    render() {
        return (
            <div>
                <SelectBox onInitialized={this.saveInstance} />
            </div>
        );
    }
}

• Get a UI component Instance in jQuery

• Get a UI component Instance in Angular

• Get a UI component Instance in Vue

• Get a UI component Instance in React

A function that is executed each time the UI component's input is changed while the UI component is focused.

Selector: @input

Information about the event.

Object structure:

Default Value: null

A function that is executed when a list item is clicked or tapped.

Selector: @item-click

Information about the event.

Object structure:

Default Value: null

A function that is executed when a user is pressing a key on the keyboard.

Selector: @key-down

Information about the event.

Object structure:

Default Value: null

A function that is executed when a user releases a key on the keyboard.

Selector: @key-up

Information about the event.

Object structure:

Default Value: null

A function that is executed once the drop-down editor is opened.

Selector: @opened

Information about the event.

Object structure:

Default Value: null

A function that is executed after a UI component property is changed.

Selector: @option-changed

Information about the event.

Object structure:

The modified property's new value.

The UI component's previous value.

String

The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into.

String

The path to the modified property that includes all parent properties.

HTMLElement | jQuery

The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.

SelectBox

The UI component's instance.

Default Value: null

The following example shows how to subscribe to component property changes:

$(function() {
    $("#selectBoxContainer").dxSelectBox({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-select-box ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-select-box>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxSelectBoxModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxSelectBoxModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  

<template> 
    <DxSelectBox ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxSelectBox from 'devextreme-vue/select-box'; 

export default { 
    components: { 
        DxSelectBox
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import SelectBox from 'devextreme-react/select-box'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <SelectBox ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

A function that is executed when the UI component's input has been pasted.

Selector: @paste

Information about the event.

Object structure:

Default Value: null

A function that is executed when a list item is selected or selection is canceled.

Selector: @selection-changed

Information about the event.

Object structure:

Default Value: null

A function that is executed after the UI component's value is changed.

Selector: @value-changed

Information about the event.

Object structure:

Default Value: null

Specifies whether or not the drop-down editor is displayed.

Specifies whether a user can open the drop-down list by clicking a text field.

Selector: open-on-field-click

Default Value: true

The text that is provided as a hint in the select box editor.

View Demo

Specifies whether the editor is read-only.

Selector: read-only

Default Value: false

When this property is set to true, the following applies:

• The editor's value cannot be changed using the UI.
• Built-in action buttons are invisible.

• Custom action buttons are visible but disabled. If a button should not be disabled, set its disabled property to false:

  jQuery

  $(function() {
      $("#selectBoxContainer").dxSelectBox({
          // ...
          buttons: [{
              name: "myCustomButton",
              location: "after",
              options: {
                  onClick: function(e) {
                      // ...
                  },
                  disabled: false
              }
          }]
      });
  });

  Angular

  <dx-select-box ... >
      <dxi-button
          name="myCustomButton"
          location="after"
          [options]="myCustomButtonConfig">
      </dxi-button>
  </dx-select-box>

  import { Component } from '@angular/core';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      myCustomButtonConfig = {
          onClick: (e) => {
              // ...
          },
          disabled: false
      };
  }

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxSelectBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxSelectBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  <template>
      <DxSelectBox ... >
          <DxSelectBoxButton
              name="myCustomButton"
              location="after"
              :options="myCustomButtonConfig"
          />
      </DxSelectBox>
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import DxSelectBox, {
      DxButton as DxSelectBoxButton
  } from 'devextreme-vue/select-box';
  
  export default {
      components: {
          DxSelectBox,
          DxSelectBoxButton
      },
      data() {
          return {
              myCustomButtonConfig: {
                  onClick: (e) => {
                      // ...
                  },
                  disabled: false
              }
          }
      }
  }
  </script>

  React

  import React from 'react';
  
  import 'devextreme/dist/css/dx.light.css';
  
  import SelectBox, {
      Button as SelectBoxButton
  } from 'devextreme-react/select-box';
  
  class App extends React.Component {
      myCustomButtonConfig = {
          onClick: (e) => {
              // ...
          },
          disabled: false
      };
      render() {
          return (
              <SelectBox>
                  <SelectBoxButton
                      name="myCustomButton"
                      location="after"
                      options={this.myCustomButtonConfig}
                  />
              </SelectBox>
          );
      }
  }
  export default App;

  You can also hide a custom action button when the UI component becomes read-only. Set the button's visible property to false in the onOptionChanged function. To get the button, use the getButton(name) method:

  jQuery

  $(function() {
      $("#selectBoxContainer").dxSelectBox({
          // ...
          buttons: [{
              name: "myCustomButton",
              // ...
          }],
          onOptionChanged: function(e) {
              if(e.name == "readOnly") {
                  const myButton = e.component.getButton("myCustomButton");
                  myButton.option("visible", !e.value); // Hide the button when readOnly: true
              }
          }
      });
  });

  Angular

  <dx-select-box ...
      (onOptionChanged)="changeButtonState">
      <dxi-button
          name="myCustomButton"
          ...
      ></dxi-button>
  </dx-select-box>

  import { Component } from '@angular/core';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      changeButtonState(e) {
          if(e.name == 'readOnly') {
              let myButton = e.component.getButton('myCustomButton');
              myButton.option('visible', !e.value); // Hide the button when readOnly: true
          }
      }
  }

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxSelectBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxSelectBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  <template>
      <DxSelectBox ...
          @option-changed="changeButtonState">
          <DxSelectBoxButton
              name="myCustomButton"
              ...
          />
      </DxSelectBox>
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import DxSelectBox, {
      DxButton as DxSelectBoxButton
  } from 'devextreme-vue/select-box';
  
  export default {
      components: {
          DxSelectBox,
          DxSelectBoxButton
      },
      data() {
          return {
              // ...
          }
      },
      methods: {
          changeButtonState(e) {
              if(e.name == 'readOnly') {
                  let myButton = e.component.getButton('myCustomButton');
                  myButton.option('visible', !e.value); // Hide the button when readOnly: true
              }
          }
      }
  }
  </script>

  React

  import React from 'react';
  
  import 'devextreme/dist/css/dx.light.css';
  
  import SelectBox, {
      Button as SelectBoxButton
  } from 'devextreme-react/select-box';
  
  class App extends React.Component {
      changeButtonState(e) {
          if(e.name == 'readOnly') {
              let myButton = e.component.getButton('myCustomButton');
              myButton.option('visible', !e.value); // Hide the button when readOnly: true
          }
      }
      render() {
          return (
              <SelectBox ...
                  onOptionChanged={this.changeButtonState}>
                  <SelectBoxButton
                      name="myCustomButton"
                      ...
                  />
              </SelectBox>
          );
      }
  }
  export default App;

View Demo

Switches the UI component to a right-to-left representation.

Selector: rtl-enabled

Default Value: false

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

Specifies whether to allow search operations.

Selector: search-enabled

Default Value: false

View Demo

Searching works with source data of plain structure only. Subsequently, data can be transformed to hierarchical structure using the

's

property.

• Configure Search Parameters

Specifies the name of a data source item field or an expression whose value is compared to the search criterion.

Selector: search-expr

Default Value: null

In most cases, you should pass the name of a field by whose value data items are searched. If you need to search elements by several field values, assign an array of field names to this property.

searchExpr: ["firstName", "lastName"]

For more information on searching, refer to the Search API section of the Data Layer article. For information on getters, refer to the Getters and Setters section of the Data Layer article.

View Demo

Specifies a comparison operation used to search UI component items.

Selector: search-mode

Default Value: 'contains'

This property changes how users search SelectBox items and controls the component's auto-fill functionality. The following values are available for searchMode:

• 'contains'
  Searches items that contain the typed text. SelectBox does not activate autofill.

• 'startswith'
  Searches items that start with the typed text. SelectBox autofills the input with the first matched item if acceptCustomValue is false (default). If acceptCustomValue is true, the component does not activate autofill.

View Demo

Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed.

Selector: search-timeout

Default Value: 500

View Demo

Gets the currently selected item.

Selector: selected-item

Type: any

Read-only

Default Value: null

Specifies whether to display the Clear button in the UI component.

Selector: show-clear-button

Default Value: false

The Clear button calls the reset method.

Specifies whether or not the UI component displays unfiltered values until a user types a number of characters exceeding the minSearchLength property value.

Selector: show-data-before-search

Default Value: false

If this property is disabled, the UI component does not display values until the number of typed characters exceeds the minSearchLength value, otherwise it displays all values regardless of the specified filtering condition.

View Demo

Specifies whether the drop-down button is visible.

Selector: show-drop-down-button

Default Value: true

Specifies whether or not to display selection controls.

Selector: show-selection-controls

Default Value: false

Specifies whether or not the UI component checks the inner text for spelling mistakes.

Specifies how the UI component's text field is styled.

Selector: styling-mode

Default Value: 'outlined', 'filled' (Material)

The following styles are available:

You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.

Specifies the number of the element when the Tab key is used for navigating.

Selector: tab-index

Default Value: 0

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

The read-only property that holds the text displayed by the UI component input element.

Specifies whether the SelectBox uses item's text a title attribute.

Selector: use-item-text-as-title

Default Value: false

If the property is set to true, the text that items within the SelectBox contain is passed to the title attribute of the respective item.

Information on the broken validation rule. Contains the first item from the validationErrors array.

Selector: validation-error

Type: any

Default Value: null

An array of validation errors.

Selector: validation-errors

Default Value: null

SelectBox updates this property automatically as it validates values. You can also update validationErrors manually to display custom errors and implement custom validation logic. The following code snippet demonstrates how to define items in this array:

$('#select-box').dxSelectBox({
    isValid: false,
    validationErrors: [{ message: "Custom validation error" }],
})

<dx-select-box
    [isValid]="false"
    [validationErrors]="validationErrors"
></dx-select-box>

import { DxSelectBoxComponent } from 'devextreme-angular/ui/select-box'

export class AppComponent {
    validationErrors = [
        { message: 'Custom validation error' }
    ];
}

<script setup lang="ts">
import { DxSelectBox } from 'devextreme-vue/select-box';

const validationErrors = [
    { message: 'Custom validation error' }
];
</script>

<template>
    <DxSelectBox 
        :is-valid="false"
        :validation-errors="validationErrors"
    />
</template>

import { SelectBox } from 'devextreme-react/select-box';

const validationErrors = [
    { message: 'Custom validation error' }
];

function App(): JSX.Element {
    return (
        <SelectBox
            isValid={false}
            validationErrors={validationErrors}
        />
    )
}

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

Selector: validation-message-mode

Default Value: 'auto'

The following property values are possible:

• auto
  The tooltip with the message is displayed when the editor is in focus.
• always
  The tooltip with the message is not hidden when the editor loses focus.

Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy.

Selector: validation-message-position

Default Value: 'auto'

If you set this property to auto, the component specifies the validation message position automatically.

The following example positions a validation message at the component's right:

$(function() {
    $("#selectBoxContainer").dxSelectBox({
        // ...
        validationMessagePosition: 'right'
    }).dxValidator({
        validationRules: [{
            type: 'required',
            message: 'Required',
        }],
    });
});

<dx-select-box ...
    validationMessagePosition="right">
    <dx-validator>
        <dxi-validation-rule
            type="required"
            message="Required"
        >
        </dxi-validation-rule>
    </dx-validator>
</dx-select-box>

<template>
    <DxSelectBox ...
        validation-message-position="right"
    >
        <DxValidator>
            <DxRequiredRule message="Required" />
        </DxValidator>
    </DxSelectBox>
</template>

<script>
    // ...
</script>

import React from 'react';
// ...

function App() {
    return (
        <SelectBox ...
            validationMessagePosition="right"
        >
            <Validator>
                <RequiredRule message="Required" />
            </Validator>
        </SelectBox>
    ); 

};
export default App;

Indicates or specifies the current validation status.

Selector: validation-status

Default Value: 'valid'

The following table illustrates the validation status indicators:

When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:

$(function() {
    const selectBox = $("#selectBoxContainer").dxSelectBox({
        // ...
    }).dxSelectBox("instance");

    function setInvalidStatus(message) {
        selectBox.option({
            validationStatus: "invalid",
            validationErrors: [{ message: message }]
        });
    }
});

<dx-select-box
    [validationStatus]="validationStatus"
    [validationErrors]="validationErrors">
</dx-select-box>

// ...
export class AppComponent {
    validationStatus: string = "valid";
    validationErrors: any;
    // ...
    setInvalidStatus(message) {
        this.validationStatus = "invalid";
        this.validationErrors = [{ message: message }];
    }
}

<template>
    <DxSelectBox ...
        :validation-status="validationStatus"
        :validation-errors="validationErrors"
    />
</template>

<script>
    // ...
    export default {
        // ...
        data() {
            return {
                validationStatus: "valid",
                validationErrors: []
            }
        },
        methods: {
            setInvalidStatus(message) {
                this.validationStatus = "invalid";
                this.validationErrors = [{ message: message }];
            }
        }
    }
</script>

import React, { useState } from 'react';
// ...

function App() {
    const [validationStatus, setValidationStatus] = useState("valid");
    const [validationErrors, setValidationErrors] = useState([]);

    const setInvalidStatus = message => {
        setValidationStatus("invalid");
        setValidationErrors([{ message: message }]);
    }

    return (
        <SelectBox
            validationStatus={validationStatus}
            validationErrors={validationErrors}
        />
    ); 

};
export default App;

Specifies the currently selected value. May be an object if dataSource contains objects, the store key is specified, and valueExpr is not set.

Type: any

Default Value: null

When dataSource contains objects, you should define valueExpr to correctly identify data items. If valueExpr is not specified, the component compares object references to display an item, not object values. For instance, if you define the value property as an object containing identical values to dataSource to select all items, the component displays nothing.

Specifies the DOM events after which the UI component's value should be updated.

Selector: value-change-event

Default Value: 'input change keyup'

This property accepts a single event name or several names separated by spaces.

The recommended events are "keyup", "blur", "change", "input", and "focusout", but you can use other events as well.

• onValueChanged

Specifies which data field provides unique values to the UI component's value.

Selector: value-expr

The current item's data object.

A unique item identifier.

Default Value: 'this'

View Demo

When dataSource contains objects, you should define valueExpr to correctly identify data items. Otherwise, the component uses referential equality to compare objects, which may result in unexpected behavior.

If you use a store, the valueExpr property should have the same value as the key in the store. Alternatively, you can use this as a valueExpr but the key should be specified. Refer to the following article for more information: Troubleshooting - A Drop-Down Editor Does Not Show Data.

Do not use template as a valueExpr value.

You cannot specify valueExpr as a function when the UI component is bound to a remote data source. This is because valueExpr is used in a filter the UI component sends to the server when querying data. Functions with custom logic cannot be serialized for this filter.

• displayExpr

Specifies whether the UI component is visible.

Specifies the UI component's width.

This property accepts a value of one of the following types:

• Number
  The width in pixels.

• String
  A CSS-accepted measurement of width. For example, "55px", "20vw", "80%", "auto", "inherit".

Specifies whether text that exceeds the drop-down list width should be wrapped.

Selector: wrap-item-text

Default Value: false

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4