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

Drop Down Button

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

Menu items can be specified in the items or dataSource properties. Use dataSource if data is remote or should be processed. To customize menu items, implement an itemTemplate.

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

You can implement a dropDownContentTemplate to replace the drop-down menu with custom content.

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

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

Backend API
Copy to CodeSandBox
<div class="dx-fieldset"> <div class="dx-fieldset-header">Single usage</div> <div class="dx-field"> <div class="dx-field-label"> Custom static text </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 main button action </div> <div class="dx-field-value"> <dx-drop-down-button [splitButton]="true" [useSelectMode]="false" text="Sandra Johnson" icon="../../../../images/gym/coach-woman.png" [items]="profileSettings" displayExpr="name" keyExpr="id" (onButtonClick)="onButtonClick($event)" (onItemClick)="onItemClick($event)" ></dx-drop-down-button> </div> </div> </div> <div class="dx-fieldset"> <div class="dx-fieldset-header">Usage 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" [ngClass]="{ 'dx-theme-text-color': !iconColor }" [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 { NgModule, Component, ViewChild, enableProdMode, } from '@angular/core'; import { BrowserModule, BrowserTransferStateModule } from '@angular/platform-browser'; import { platformBrowserDynamic } from '@angular/platform-browser-dynamic'; import notify from 'devextreme/ui/notify'; import { DxDropDownButtonModule, DxToolbarModule, } from 'devextreme-angular'; import { SimpleObject, Service } from './app.service'; if (!/localhost/.test( { enableProdMode(); } @Component({ selector: 'demo-app', templateUrl: 'app/app.component.html', styleUrls: ['app/app.component.css'], providers: [Service], }) export class AppComponent { fontSize: number; color: string; lineHeight: number; alignment: string; dropDownButton: any; colors: string[]; downloads: string[]; profileSettings: SimpleObject[]; fontSizes: SimpleObject[]; lineHeights: SimpleObject[]; alignments: SimpleObject[]; constructor(service: Service) { this.fontSize = 14; this.color = null; this.lineHeight = 1.35; this.alignment = 'left'; 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) => { this.alignment = e.item.value; }; onFontSizeChanged = (e) => { this.fontSize = e.item.value; }; onLineHeightChanged = (e) => { this.lineHeight = e.item.value; }; onButtonClick(e) { notify(`Go to ${e.component.option('text')}'s profile`, 'success', 600); } onItemClick(e) { notify( || e.itemData, 'success', 600); } onColorPickerInit = (e) => { this.dropDownButton = e.component; }; onColorClick(color) { this.color = color; this.dropDownButton.element().getElementsByClassName('dx-icon-square')[0].style.color = color; this.dropDownButton.close(); } } @NgModule({ imports: [ BrowserModule, BrowserTransferStateModule, DxDropDownButtonModule, DxToolbarModule, ], declarations: [AppComponent], bootstrap: [AppComponent], }) export class AppModule { } platformBrowserDynamic().bootstrapModule(AppModule);
::ng-deep .demo-container .dx-fieldset:first-child { width: 500px; } ::ng-deep .custom-color-picker { width: 82px; padding: 5px; } ::ng-deep .dx-button-content img.dx-icon { width: 24px; height: 24px; } ::ng-deep .color { cursor: pointer; font-size: 18px; }
import { Injectable } from '@angular/core'; export class SimpleObject { value: number | string; name: string; icon?: string; badge?: string; } const colors = [null, '#980000', '#ff0000', '#ff9900', '#ffff00', '#00ff00', '#00ffff', '#4a86e8', '#0000ff', '#9900ff', '#ff00ff', '#ff3466']; const profileSettings: SimpleObject[] = [ { 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: SimpleObject[] = [ { 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: SimpleObject[] = [ { value: 10, name: '10px' }, { value: 12, name: '12px' }, { value: 14, name: '14px' }, { value: 16, name: '16px' }, { value: 18, name: '18px' }, ]; const lineHeights: SimpleObject[] = [ { 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(): SimpleObject[] { return alignments; } getProfileSettings(): SimpleObject[] { return profileSettings; } getFontSizes(): SimpleObject[] { return fontSizes; } getLineHeights(): SimpleObject[] { 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: // window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, }, meta: { 'typescript': { 'exports': 'ts', }, 'devextreme/localization.js': { 'esModule': true, }, }, paths: { 'npm:': '', }, map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', '@angular/core': 'npm:@angular/core@12.2.17', '@angular/platform-browser': 'npm:@angular/platform-browser@12.2.17', '@angular/platform-browser-dynamic': 'npm:@angular/platform-browser-dynamic@12.2.17', '@angular/forms': 'npm:@angular/forms@12.2.17', '@angular/common': 'npm:@angular/common@12.2.17', '@angular/compiler': 'npm:@angular/compiler@12.2.17', 'tslib': 'npm:tslib@2.3.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', 'devextreme': 'npm:devextreme@23.1.5/cjs', 'devextreme/bundles/dx.all': 'npm:devextreme@23.1.5/bundles/dx.all.js', 'jszip': 'npm:jszip@3.7.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.6.2/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.1', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.48', 'devextreme-angular': 'npm:devextreme-angular@23.1.5', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.11', '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.4/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.4/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.11/inferno/package.json', 'npm:@angular/*/package.json', 'npm:@angular/common@12.2.17/*/package.json', 'npm:rxjs@7.5.3/package.json', 'npm:rxjs@7.5.3/operators/package.json', 'npm:devextreme-angular@23.1.5/*/package.json', 'npm:devextreme-angular@23.1.5/ui/*/package.json', 'npm:devextreme-angular@23.1.5/package.json', 'npm:devexpress-diagram@2.2.1/package.json', 'npm:devexpress-gantt@4.1.48/package.json', ], }; System.config(window.config);
<!DOCTYPE html> <html xmlns=""> <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=1.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>