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

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

Vue DropDownBox Props | Vue Documentation

An object defining configuration properties for the DropDownBox UI component.

Specifies whether the UI component allows a user to enter a custom value.

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 a custom template for the drop-down content.

Selector: content-template

DropDownBox

The UI component's instance.

The currently selected value.

Default Name: 'content'

Binds the UI component to data.

Selector: data-source

Default Value: null

The DropDownBox works with collections of objects or string, number, or boolean values. The component does not support hierarchical data sources.

Depending on your data source, bind DropDownBox to data as follows. In each case, also specify the valueExpr and displayExpr properties 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";
      $("#dropDownBoxContainer").dxDropDownBox({
          // ...
          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-drop-down-box ...
      [dataSource]="store">
  </dx-drop-down-box>

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

  Vue

  <template> 
      <DxDropDownBox ...
          :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 { DxDropDownBox } from 'devextreme-vue/drop-down-box';
  
  export default {
      components: {
          DxDropDownBox
      },
      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 DropDownBox from 'devextreme-react/drop-down-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 (
              <DropDownBox ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the DropDownBox 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.

If the element embedded in the DropDownBox UI component is another DevExtreme UI component, their data sources should be interrelated. Refer to the Synchronize with the Embedded Element article for more information.

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 ].

• DropDownBox 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.

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.

Specifies the data field whose values should be displayed.

Selector: display-expr

The current item's data object.

Default Value: undefined

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

Customizes text before it is displayed in the input field.

Selector: display-value-formatter

One or more values from the displayExpr that correspond(s) to the selected UI component values.

Text for the input field.

This function receives values from the data field set in the displayExpr property and should return a string that contains text for the input field. If the displayExpr is not set, the function receives full data objects.

The following code demonstrates how to change separators from commas to semicolons by using the displayValueFormatter function. You can try it if you copy this code to the Multiple Selection demo:

$(function() {
    $("#dropDownBoxContainer").dxDropDownBox({
        displayValueFormatter: function(value) {
            return Array.isArray(value) ? value.join("; ") : value;
        },
        // ...
    });
});

<dx-drop-down-box ...
    [displayValueFormatter]="displayValueFormatter"
>
    <!-- ... -->
</dx-drop-down-box>

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

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
    displayValueFormatter(value) {
        return Array.isArray(value) ? value.join("; ") : value;
    }
}

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

import { DxDropDownBoxModule } from 'devextreme-angular';

@NgModule({
declarations: [
    AppComponent
],
imports: [
    BrowserModule,
    DxDropDownBoxModule
],
providers: [],
bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxDropDownBox ...
        :display-value-formatter="displayValueFormatter"
    >
        <!-- ... -->
    </DxDropDownBox>
</template>

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

import { DxDropDownBox } from 'devextreme-vue/drop-down-box';

export default {
    components: {
        DxDropDownBox
    },
    // ...
    methods: {
        displayValueFormatter: function(value) {
            return Array.isArray(value) ? value.join("; ") : value;
        }
    }    
};
</script>

import React from 'react';

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

import { DropDownBox } from 'devextreme-react/drop-down-box';

class App extends React.Component {
    render() {
        return (
            <DropDownBox ...
                displayValueFormatter={this.displayValueFormatter}
            />
        );
    }

    displayValueFormatter(value) {
        return Array.isArray(value) ? value.join("; ") : value;
    }
}

export default App;

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(){
    $("#dropDownBoxContainer").dxDropDownBox({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

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

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

<template>
    <DxDropDownBox ...
        :element-attr="dropDownBoxAttributes">
    </DxDropDownBox>
</template>

<script>
import DxDropDownBox from 'devextreme-vue/drop-down-box';

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

import React from 'react';

import DropDownBox from 'devextreme-react/drop-down-box';

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

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

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

Selector: field-template

Object

Selected values.

Default Name: null

In the following code, the fieldTemplate is used to stylize the text field with a custom CSS class:

$(function () {
    $("#dropDownBoxContainer").dxDropDownBox({
        // ...
        fieldTemplate: function (value, fieldElement) {
            const result = $("<div class='custom-item'>");
            result
                .dxTextBox({
                    value: value,
                    readOnly: true
                });
            fieldElement.append(result);
        }
    });
});

.custom-item {
    font-size: 16px;
}

<dx-drop-down-box ...
    fieldTemplate="field">
    <div *dxTemplate="let data of 'field'">
        <div class="custom-item">
            <dx-text-box
                [value]="data"
                [readOnly]="true"
            ></dx-text-box>
        </div>
    </div>
</dx-drop-down-box>

.custom-item {
    font-size: 16px;
}

<template>
    <DxDropDownBox ...
        field-template="field">
        <template #field="{ value }">
            <div class="custom-item">
                <DxTextBox
                    :value="value"
                    :read-only="true"
                />
            </div>
        </template>
    </DxDropDownBox>
</template>

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

import DxDropDownBox from 'devextreme-vue/drop-down-box';
import DxTextBox from 'devextreme-vue/text-box';

export default {
    components: {
        DxDropDownBox,
        DxTextBox,
    },
    data() {
        // ...
    },
    methods: {
        // ...
    }
};
</script>

.custom-item {
    font-size: 16px;
}

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

import { DropDownBox } from 'devextreme-react/drop-down-box';
import { TextBox } from 'devextreme-react/text-box';

const fieldRender = value => {
    return (
        <div class="custom-item">
            <TextBox
                defaultValue={value}
                readOnly={true}
            />
        </div>
    );
}

const App = () => <DropDownBox fieldRender={fieldRender}/>;

export default App;

.custom-item {
    font-size: 16px;
}

• Custom Templates

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

Selector: focus-state-enabled

Default Value: true

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(){
    $("#dropDownBoxContainer").dxDropDownBox({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});

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

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

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

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

import DxDropDownBox from 'devextreme-vue/drop-down-box';

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

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

import DropDownBox from 'devextreme-react/drop-down-box';

const inputAttr = { id: 'inputId' };

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

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

@(Html.DevExtreme().DropDownBox() _
    .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(){
    $("#dropDownBoxContainer").dxDropDownBox({
        // ...
        inputAttr: {
            'aria-label': 'your-label',
        },
    });
});

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

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

<script>
import DxDropDownBox from 'devextreme-vue/drop-down-box';

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

import DropDownBox from 'devextreme-react/drop-down-box';

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

export default function App() {
    return (
        <DropDownBox
            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 dropDownBox = $('#dropDownBox').dxDropDownBox({
        // ...
    }).dxDropDownBox('instance');

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

import { Component, ViewChild } from '@angular/core';
import { DxDropDownBoxComponent, 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('dropDownBoxRef', { static: false }) dropDownBox: DxDropDownBoxComponent;

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

<dx-drop-down-box ... 
    #dropDownBoxRef
>
</dx-drop-down-box>
<dx-button ...
    (onClick)="onClick($event)"
>
</dx-button>

<template>
    <DxDropDownBox ...
        :ref="dropDownBoxRef"
    >
    </DxDropDownBox>
    <DxButton ...
        @click="onClick"
    />
</template>

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

export default {
    components: {
        DxDropDownBox,
        DxButton
    },

    data() {
        return {
            dropDownBoxRef
        }
    },

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

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

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

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

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

    return (
        <DropDownBox ...
            ref={dropDownBoxRef}
        >
        </DropDownBox>
        <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 used to synchronize the DropDownBox with an embedded UI component.

The DropDownBox uses other UI components to render items. Use the contentTemplate to embed a UI component such as the List or the TreeView. In this case, items are displayed in accordance with the configuration and functionality of the embedded UI component.

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

dropDownBoxInstance.option('items', newItems);

You can use the dataSource property instead of items. It accepts the DataSource object whose underlying stores include 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).

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 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.

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's input has been copied.

Selector: @copy

Information about the event.

Object structure:

Default Value: null

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-drop-down-box ...
    (onInitialized)="saveInstance($event)">
</dx-drop-down-box>

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

App.vue (Composition API)

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

<script>
import DxDropDownBox from 'devextreme-vue/drop-down-box';

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

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

<script setup>
import DxDropDownBox from 'devextreme-vue/drop-down-box';

let dropDownBoxInstance = null;

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

import DropDownBox from 'devextreme-react/drop-down-box';

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

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

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

    render() {
        return (
            <div>
                <DropDownBox 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 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.

DropDownBox

The UI component's instance.

Default Value: null

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

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

<dx-drop-down-box ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-drop-down-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 { DxDropDownBoxModule } from 'devextreme-angular'; 

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

export class AppModule { }  

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

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxDropDownBox from 'devextreme-vue/drop-down-box'; 

export default { 
    components: { 
        DxDropDownBox
    }, 
    // ...
    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 DropDownBox from 'devextreme-react/drop-down-box'; 

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

export default function App() { 
    return ( 
        <DropDownBox ...
            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 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

Specifies a text string displayed when the editor's value is empty.

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() {
      $("#dropDownBoxContainer").dxDropDownBox({
          // ...
          buttons: [{
              name: "myCustomButton",
              location: "after",
              options: {
                  onClick: function(e) {
                      // ...
                  },
                  disabled: false
              }
          }]
      });
  });

  Angular

  <dx-drop-down-box ... >
      <dxi-button
          name="myCustomButton"
          location="after"
          [options]="myCustomButtonConfig">
      </dxi-button>
  </dx-drop-down-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 { DxDropDownBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxDropDownBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

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

  React

  import React from 'react';
  
  import 'devextreme/dist/css/dx.light.css';
  
  import DropDownBox, {
      Button as DropDownBoxButton
  } from 'devextreme-react/drop-down-box';
  
  class App extends React.Component {
      myCustomButtonConfig = {
          onClick: (e) => {
              // ...
          },
          disabled: false
      };
      render() {
          return (
              <DropDownBox>
                  <DropDownBoxButton
                      name="myCustomButton"
                      location="after"
                      options={this.myCustomButtonConfig}
                  />
              </DropDownBox>
          );
      }
  }
  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() {
      $("#dropDownBoxContainer").dxDropDownBox({
          // ...
          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-drop-down-box ...
      (onOptionChanged)="changeButtonState">
      <dxi-button
          name="myCustomButton"
          ...
      ></dxi-button>
  </dx-drop-down-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 { DxDropDownBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxDropDownBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  <template>
      <DxDropDownBox ...
          @option-changed="changeButtonState">
          <DxDropDownBoxButton
              name="myCustomButton"
              ...
          />
      </DxDropDownBox>
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import DxDropDownBox, {
      DxButton as DxDropDownBoxButton
  } from 'devextreme-vue/drop-down-box';
  
  export default {
      components: {
          DxDropDownBox,
          DxDropDownBoxButton
      },
      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 DropDownBox, {
      Button as DropDownBoxButton
  } from 'devextreme-react/drop-down-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 (
              <DropDownBox ...
                  onOptionChanged={this.changeButtonState}>
                  <DropDownBoxButton
                      name="myCustomButton"
                      ...
                  />
              </DropDownBox>
          );
      }
  }
  export default App;

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 display the Clear button in the UI component.

Selector: show-clear-button

Default Value: false

The Clear button calls the reset method.

Specifies whether the drop-down button is visible.

Selector: show-drop-down-button

Default Value: true

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.

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

DropDownBox 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:

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

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

import { DxDropDownBoxComponent } from 'devextreme-angular/ui/drop-down-box'

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

<script setup lang="ts">
import { DxDropDownBox } from 'devextreme-vue/drop-down-box';

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

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

import { DropDownBox } from 'devextreme-react/drop-down-box';

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

function App(): JSX.Element {
    return (
        <DropDownBox
            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() {
    $("#dropDownBoxContainer").dxDropDownBox({
        // ...
        validationMessagePosition: 'right'
    }).dxValidator({
        validationRules: [{
            type: 'required',
            message: 'Required',
        }],
    });
});

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

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

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

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

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

};
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 dropDownBox = $("#dropDownBoxContainer").dxDropDownBox({
        // ...
    }).dxDropDownBox("instance");

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

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

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

<template>
    <DxDropDownBox ...
        :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 (
        <DropDownBox
            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: 'change'

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'

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".

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