Angular DropDownButton Properties

See Also

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

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.

The DropDownButton works with collections of objects or string or number values.

Depending on your data source, bind DropDownButton to data as follows. If the data source provides objects, also specify the keyExpr and displayExpr properties. Note that particular fields in the objects can control the UI component's appearance. See the Default Templates for more information.

• 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

  JavaScript

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

  Angular

  app.component.ts

  app.component.html

  app.module.ts

  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-button ...
      [dataSource]="store">
  </dx-drop-down-button>

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

  Vue

  App.vue

  <template> 
      <DxDropDownButton ...
          :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 { DxDropDownButton } from 'devextreme-vue/drop-down-button';
  
  export default {
      components: {
          DxDropDownButton
      },
      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

  App.js

  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 DropDownButton from 'devextreme-react/drop-down-button';
  
  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 (
              <DropDownButton ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the DropDownButton 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 this property is false, the content is rendered once the UI component is initialized.

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

displayExpr: "name"

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

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

Do not change the default value if the data source contains primitives.

The drop-down field contains the List UI component. Implement this template to replace the UI component with custom content. The following restrictions apply when the template is specified:

• itemTemplate is ignored;
• onItemClick and onSelectionChanged are never executed;
• selectedItemKey should be updated manually.

See Also

• Custom Templates

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

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

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.

This property accepts one of the following:

• The icon's URL
• The icon's name if the icon is from the DevExtreme icon library
• The icon's CSS class if the icon is from an external icon library (see External Icon Libraries)
• The icon in the Base64 format
• The icon in the SVG format. Ensure that the source is reliable.

The items array can contain:

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

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

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

See Also

• Custom Templates

Alternatively, you can specify the key in the store assigned to the dataSource.

The DropDownButton component evaluates the noDataText property's value. This evaluation, however, makes the DropDownButton 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.

<dx-drop-down-button ...
    (onInitialized)="saveInstance($event)">
</dx-drop-down-button>

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

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

<script>
import DxDropDownButton from 'devextreme-vue/drop-down-button';

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

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

<script setup>
import DxDropDownButton from 'devextreme-vue/drop-down-button';

let dropDownButtonInstance = null;

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

import DropDownButton from 'devextreme-react/drop-down-button';

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

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

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

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

See Also

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

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

<dx-drop-down-button ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-drop-down-button>

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 { DxDropDownButtonModule } from 'devextreme-angular'; 

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

export class AppModule { }  

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

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

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

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

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

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

See Also

• selectedItemKey

Keys are taken from the data field specified in the UI component's keyExpr property or the key property of the store that underlies the dataSource.

See Also

• selectedItem

The following table demonstrates how the showArrowIcon property affects the DropDownButton's appearance:

showArrowIcon value	Result
showArrowIcon: true
showArrowIcon: false

DevExtreme supplies the following drop-down button styling modes:

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

The following code sample creates a DropDownButton with multiline text in the base button.

$(function() {
    $("#myDropDownButton").dxDropDownButton({
         height: "auto",
        width: "auto",
        icon: 'todo',
        text: 'Done',
        template: (data, $element) => {
            $(`<span class="dx-icon-${data.icon} dx-icon"></span>`).appendTo($element);
            const $textContainer = $('<div class="text-container">').appendTo($element);
            $(`<div class='status'>${data.text}</div>`).appendTo($textContainer);
            $(`<div class='additional-status'>Or not done</div>`).appendTo($textContainer);
            $(`<span class="dx-icon-spindown dx-icon"></span>`).appendTo($element);
        },
    });
});

.text-container {
    padding: 10px;
    display: flex;
    flex-direction: column;
    align-items: flex-start;
    line-height: 1;
}

.additional-status {
    color: lightgray;
}

.dx-icon-spindown:before {
    padding-left: 32px;
}

<dx-drop-down-button
    icon="todo"
    text="Done"
    height="auto"
    width="auto"
    template="button-template"
>
    <div *dxTemplate="let data of 'button-template'">
        <span class="dx-icon-{{ data.icon }} dx-icon"></span>
        <div class="text-container">
        <div class="status">{{ data.text }}</div>
        <div class="additional-status">Or not done</div>
        </div>
        <span class="dx-icon-spindown dx-icon"></span>
    </div>
</dx-drop-down-button>

.text-container {
    padding: 10px;
    display: flex;
    flex-direction: column;
    align-items: flex-start;
    line-height: 1;
}

.additional-status {
    color: lightgray;
}

.dx-icon-spindown:before {
    padding-left: 32px;
}

<template>
    <DxDropDownButton
        icon="todo"
        text="Done"
        height="auto"
        width="auto"
        template="button-template"
    >
        <template #button-template="{ data }">
            <span :class="'dx-icon-' + data.icon + ' dx-icon'"></span>
            <div class="text-container">
                <div class="status">{{ data.text }}</div>
                <div class="additional-status">Or not done</div>
            </div>
            <span class="dx-icon-spindown dx-icon"></span>
        </template>
    </DxDropDownButton>
</template>

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

<style>
.text-container {
    padding: 10px;
    display: flex;
    flex-direction: column;
    align-items: flex-start;
    line-height: 1;
}

.additional-status {
    color: lightgray;
}

.dx-icon-spindown:before {
    padding-left: 32px;
}
</style>

// ...
const renderButton = (data) => {
    return (
        <React.Fragment>
            <span className={"dx-icon-" + data.icon + " dx-icon"}></span>
            <div className="text-container">
                <div className="status">{data.text}</div>
                <div className="additional-status">Or not done</div>
            </div>
            <span className="dx-icon-spindown dx-icon"></span>
        </React.Fragment>
    );
};

export default function App() {
    return (
        <Button
            icon="todo"
            text="Done"
            height="auto"
            width="auto"
            render={renderButton}
        />
    );
}

.text-container {
    padding: 10px;
    display: flex;
    flex-direction: column;
    align-items: flex-start;
    line-height: 1;
}

.additional-status {
    color: lightgray;
}

.dx-icon-spindown:before {
    padding-left: 32px;
}

View Demo

See Also

• Custom Templates

DevExtreme supplies the following drop-down button types:

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

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

• The selectedItemKey and selectedItem properties can be used.

• The onSelectionChanged function can be executed.

• The button's text and icon are taken from the selected item. If you use the dropDownContentTemplate, you should update the selectedItemKey and the button's appearance.

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

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.