DevExtreme v24.1 is now available.

Explore our newest features/capabilities and share your thoughts with us.

Your search did not match any results.

Drop Down Button

DropDownButton is a button that opens a drop-down menu. The button displays a text and an icon.

To get started with the DevExtreme DropDownButton component, refer to the following tutorial for step-by-step instructions: Getting Started with DropDownButton.

DevExtreme Accessibility Compliance
DevExtreme component libraries meet a variety of WCAG and Section 508 compliance standards. To assess this demo’s accessibility level, click the Run AXE® Validation button to launch the AXE® web accessibility evaluation tool.
All trademarks or registered trademarks are property of their respective owners. AXE® Terms of Use
The overall accessibility level of your application depends on the DropDownButton features used.
Backend API
<div class="dx-fieldset"> <div class="dx-fieldset-header">Standalone button</div> <div class="dx-field"> <div class="dx-field-label">Text and icon</div> <div class="dx-field-value"> <dx-drop-down-button text="Download Trial" [dropDownOptions]="{ width: 230 }" icon="save" [items]="downloads" (onItemClick)="onItemClick($event)" ></dx-drop-down-button> </div> </div> <div class="dx-field"> <div class="dx-field-label">Custom template and actions</div> <div class="dx-field-value"> <dx-drop-down-button id="custom-template" [splitButton]="true" [useSelectMode]="false" [items]="profileSettings" displayExpr="name" keyExpr="id" (onButtonClick)="onButtonClick($event)" (onItemClick)="onItemClick($event)" template="template" > <div *dxTemplate="let data of 'template'"> <div class="button-img-container"> <div class="button-img-indicator"></div> <img class="button-img" src="../../../../images/employees/51.png" alt="employee" /> </div> <div class="text-container"> <div class="button-title">Olivia Peyton</div> <div class="button-row">IT Manager</div> </div> </div> </dx-drop-down-button> </div> </div> </div> <div class="dx-fieldset"> <div class="dx-fieldset-header">Embedded in a Toolbar</div> <div class="dx-field"> <dx-toolbar> <dxi-item location="before" widget="dxDropDownButton" [options]="{ items: alignments, displayExpr: 'name', keyExpr: 'value', selectedItemKey: 'justify', width: 125, stylingMode: 'text', useSelectMode: true, onSelectionChanged: onAlignmentChanged }" > </dxi-item> <dxi-item location="before" widget="dxDropDownButton" [options]="{ onInitialized: onColorPickerInit, items: colors, icon: 'square', stylingMode: 'text', dropDownOptions: { width: 'auto' }, dropDownContentTemplate: 'colorpicker' }" > </dxi-item> <dxi-item location="before" widget="dxDropDownButton" [options]="{ stylingMode: 'text', displayExpr: 'name', keyExpr: 'value', useSelectMode: true, items: fontSizes, selectedItemKey: 14, onSelectionChanged: onFontSizeChanged, itemTemplate: 'fontItem' }" > </dxi-item> <dxi-item location="before" widget="dxDropDownButton" [options]="{ stylingMode: 'text', icon: 'indent', displayExpr: 'name', keyExpr: 'value', useSelectMode: true, items: lineHeights, selectedItemKey: 1.35, onSelectionChanged: onLineHeightChanged }" > </dxi-item> <div *dxTemplate="let data of 'fontItem'" [style.fontSize]="data.value + 'px'" > {{ }} </div> <div *dxTemplate="let data of 'colorpicker'"> <div class="custom-color-picker"> <i *ngFor="let iconColor of colors" class="color dx-icon dx-icon-square" [style.color]="iconColor" (click)="onColorClick(iconColor)" ></i> </div> </div> </dx-toolbar> </div> <div class="dx-field"> <p id="text" [style.fontSize]="fontSize + 'px'" [style.lineHeight]="lineHeight" [style.color]="color" [style.textAlign]="alignment" >Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</p > </div> </div>
import { enableProdMode, Component, NgModule } from '@angular/core'; import { BrowserModule } from '@angular/platform-browser'; import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; import notify from 'devextreme/ui/notify'; import { DxToolbarModule } from 'devextreme-angular'; import { DxDropDownButtonModule, DxDropDownButtonComponent, DxDropDownButtonTypes } from 'devextreme-angular/ui/drop-down-button'; import { ItemObject, Service } from './app.service'; if (!'localhost')) { enableProdMode(); } type Color = string; @Component({ selector: 'demo-app', templateUrl: 'app/app.component.html', styleUrls: ['app/app.component.css'], providers: [Service], }) export class AppComponent { dropDownButton: DxDropDownButtonComponent['instance']; colors: Color[]; downloads: string[]; profileSettings: ItemObject[]; fontSizes: ItemObject[]; lineHeights: ItemObject[]; alignments: ItemObject[]; fontSize = 14; color: string = null; lineHeight = 1.35; alignment = 'left'; constructor(service: Service) { this.colors = service.getColors(); this.fontSizes = service.getFontSizes(); this.downloads = service.getDownloads(); this.profileSettings = service.getProfileSettings(); this.alignments = service.getAlignments(); this.lineHeights = service.getLineHeights(); } onAlignmentChanged = (e: DxDropDownButtonTypes.SelectionChangedEvent): void => { this.alignment = e.item.value; }; onFontSizeChanged = (e: DxDropDownButtonTypes.SelectionChangedEvent): void => { this.fontSize = e.item.value; }; onLineHeightChanged = (e: DxDropDownButtonTypes.SelectionChangedEvent): void => { this.lineHeight = e.item.value; }; onButtonClick(e: DxDropDownButtonTypes.ButtonClickEvent): void { notify(`Go to ${e.element.querySelector('.button-title').textContent}'s profile`, 'success', 600); } onItemClick(e: DxDropDownButtonTypes.ItemClickEvent): void { notify( || e.itemData, 'success', 600); } onColorPickerInit = (e: DxDropDownButtonTypes.InitializedEvent): void => { this.dropDownButton = e.component; }; onColorClick(color: Color): void { const iconElement = this.dropDownButton.element().getElementsByClassName('dx-icon-square')[0] as HTMLElement; = color; this.color = color; this.dropDownButton.close(); } } @NgModule({ imports: [ BrowserModule, DxDropDownButtonModule, DxToolbarModule, ], declarations: [AppComponent], bootstrap: [AppComponent], }) export class AppModule { } platformBrowserDynamic().bootstrapModule(AppModule);
::ng-deep .demo-container .dx-fieldset:first-child { width: 500px; } .custom-color-picker { width: 82px; padding: 5px; } .color { cursor: pointer; font-size: 18px; } .text-container { padding-inline-start: 12px; padding-inline-end: 4px; display: flex; align-items: flex-start; flex-direction: column; } .button-img-container { position: relative; height: 32px; } .button-img { width: 32px; height: 32px; position: relative; border-width: 1px; border-style: solid; border-color: var(--dx-color-border); border-radius: 50%; } .button-img-indicator { position: absolute; background-color: var(--dx-color-danger); top: -1px; inset-inline-end: -1px; width: 10px; height: 10px; border-radius: 50%; border-width: 2px; border-style: solid; border-color: var(--dx-color-main-bg); z-index: 1; } .button-title { line-height: 20px; } .button-row { font-size: 12px; line-height: 14px; opacity: 0.6; } ::ng-deep #custom-template .dx-button { height: 46px; } ::ng-deep #custom-template .dx-button.dx-dropdownbutton-action .dx-button-content { padding-inline-start: 12px; padding-inline-end: 12px; }
import { Injectable } from '@angular/core'; import { DxDropDownButtonTypes } from 'devextreme-angular/ui/drop-down-button'; export type ItemObject = DxDropDownButtonTypes.Item & { value: number | string; name: string }; const colors = [null, '#980000', '#ff0000', '#ff9900', '#ffff00', '#00ff00', '#00ffff', '#4a86e8', '#0000ff', '#9900ff', '#ff00ff', '#ff3466']; const profileSettings: ItemObject[] = [ { value: 1, name: 'Profile', icon: 'user' }, { value: 4, name: 'Messages', icon: 'email', badge: '5', }, { value: 2, name: 'Friends', icon: 'group' }, { value: 3, name: 'Exit', icon: 'runner' }, ]; const downloads = ['Download Trial For Visual Studio', 'Download Trial For All Platforms', 'Package Managers']; const alignments: ItemObject[] = [ { value: 'left', name: 'Left', icon: 'alignleft' }, { value: 'right', name: 'Right', icon: 'alignright' }, { value: 'center', name: 'Center', icon: 'aligncenter' }, { value: 'justify', name: 'Justify', icon: 'alignjustify' }, ]; const fontSizes: ItemObject[] = [ { value: 10, name: '10px' }, { value: 12, name: '12px' }, { value: 14, name: '14px' }, { value: 16, name: '16px' }, { value: 18, name: '18px' }, ]; const lineHeights: ItemObject[] = [ { value: 1, name: '1' }, { value: 1.35, name: '1.35' }, { value: 1.5, name: '1.5' }, { value: 2, name: '2' }, ]; @Injectable() export class Service { getColors(): string[] { return colors; } getDownloads(): string[] { return downloads; } getAlignments(): ItemObject[] { return alignments; } getProfileSettings(): ItemObject[] { return profileSettings; } getFontSizes(): ItemObject[] { return fontSizes; } getLineHeights(): ItemObject[] { return lineHeights; } }
// In real applications, you should not transpile code in the browser. // You can see how to create your own application with Angular and DevExtreme here: // const componentNames = [ 'accordion', 'action-sheet', 'autocomplete', 'bar-gauge', 'box', 'bullet', 'button-group', 'button', 'calendar', 'chart', 'check-box', 'circular-gauge', 'color-box', 'context-menu', 'data-grid', 'date-box', 'date-range-box', 'defer-rendering', 'diagram', 'draggable', 'drawer', 'drop-down-box', 'drop-down-button', 'file-manager', 'file-uploader', 'filter-builder', 'form', 'funnel', 'gallery', 'gantt', 'html-editor', 'linear-gauge', 'list', 'load-indicator', 'load-panel', 'lookup', 'map', 'menu', 'multi-view', 'nested', 'number-box', 'pie-chart', 'pivot-grid-field-chooser', 'pivot-grid', 'polar-chart', 'popover', 'popup', 'progress-bar', 'radio-group', 'range-selector', 'range-slider', 'recurrence-editor', 'resizable', 'responsive-box', 'sankey', 'scheduler', 'scroll-view', 'select-box', 'slider', 'sortable', 'sparkline', 'speed-dial-action', 'splitter', 'switch', 'tab-panel', 'tabs', 'tag-box', 'text-area', 'text-box', 'tile-view', 'toast', 'toolbar', 'tooltip', 'tree-list', 'tree-map', 'tree-view', 'validation-group', 'validation-summary', 'validator', 'vector-map', ]; window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, }, meta: { 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, '@angular/platform-browser-dynamic': { 'esModule': true, }, '@angular/platform-browser': { 'esModule': true, }, '@angular/core': { 'esModule': true, }, '@angular/common': { 'esModule': true, }, '@angular/common/http': { 'esModule': true, }, '@angular/animations': { 'esModule': true, }, '@angular/forms': { 'esModule': true, }, }, paths: { 'npm:': '', 'bundles:': '../../../../bundles/', }, map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', /* @angular */ '@angular/compiler': 'bundles:@angular/compiler.umd.js', '@angular/platform-browser-dynamic': 'bundles:@angular/platform-browser-dynamic.umd.js', '@angular/core': 'bundles:@angular/core.umd.js', '@angular/core/primitives/signals': 'bundles:@angular/core.primitives.signals.umd.js', '@angular/common': 'bundles:@angular/common.umd.js', '@angular/common/http': 'bundles:@angular/common-http.umd.js', '@angular/platform-browser': 'bundles:@angular/platform-browser.umd.js', '@angular/platform-browser/animations': 'bundles:@angular/platform-browser.umd.js', '@angular/forms': 'bundles:@angular/forms.umd.js', /* devextreme */ 'devextreme': 'npm:devextreme@24.1.3/cjs', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.13', 'devextreme/bundles/dx.all': 'npm:devextreme@24.1.3/bundles/dx.all.js', 'devextreme-quill': 'npm:devextreme-quill@1.7.1/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.8', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.56', /* devextreme-angular umd maps */ 'devextreme-angular': 'bundles:devextreme-angular/devextreme-angular.umd.js', 'devextreme-angular/core': 'bundles:devextreme-angular/devextreme-angular-core.umd.js', ...componentNames.reduce((acc, name) => { acc[`devextreme-angular/ui/${name}`] = `bundles:devextreme-angular/devextreme-angular-ui-${name}.umd.js`; return acc; }, {}), 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'tslib': 'npm:tslib@2.6.1/tslib.js', 'rxjs': 'npm:rxjs@7.5.3/dist/bundles/rxjs.umd.js', 'rxjs/operators': 'npm:rxjs@7.5.3/dist/cjs/operators/index.js', 'rrule': 'npm:rrule@2.6.4/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.28.1/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'inferno': 'npm:inferno@7.4.11/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.11/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.11/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras/dist/inferno-extras.min.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.8/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.8/parser-html.js', }, packages: { 'app': { main: './app.component.ts', defaultExtension: 'ts', }, 'devextreme': { defaultExtension: 'js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, 'rxjs': { defaultExtension: 'js', }, 'rxjs/operators': { defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.13/inferno/package.json', 'npm:rxjs@7.5.3/package.json', 'npm:rxjs@7.5.3/operators/package.json', 'npm:devexpress-diagram@2.2.8/package.json', 'npm:devexpress-gantt@4.1.56/package.json', ], }; System.config(window.config); // System.import('@angular/compiler').catch(console.error.bind(console));
<!DOCTYPE html> <html xmlns="" lang="en"> <head> <title>DevExtreme Demo</title> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=5.0" /> <link rel="stylesheet" type="text/css" href="" /> <script src=""></script> <script src=""></script> <script src=""></script> <script src=""></script> <script src="config.js"></script> <script> System.import("app").catch(console.error.bind(console)); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <demo-app>Loading...</demo-app> </div> </body> </html>

Menu items can be specified in the items or dataSource properties. Use dataSource if data is remote or should be processed.

DropDownButton stores the most recent selected menu item if you set the useSelectMode property to true. In this case, the button uses the selected item's text and icon.

To customize DropDownButton, specify the the following options:

To track and handle events, use the onButtonClick, onItemClick, and onSelectionChanged event handlers.