DevExtreme v23.2 is now available.

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

Your search did not match any results.

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
import React, { useCallback, useMemo, useState } from 'react'; import DropDownButton, { DropDownButtonTypes } from 'devextreme-react/drop-down-button'; import Toolbar from 'devextreme-react/toolbar'; import { Template } from 'devextreme-react/core/template'; import { ButtonTypes } from 'devextreme-react/button'; import notify from 'devextreme/ui/notify'; import service from './data.ts'; import ColorIcon from './ColorIcon.tsx'; import 'whatwg-fetch'; type TextAlign = 'center' | 'end' | 'justify' | 'left' | 'match-parent' | 'right' | 'start'; const buttonDropDownOptions = { width: 230 }; const data = service.getData(); const itemTemplateRender = (item) => ( <div style={{ fontSize: `${item.size}px` }}> {item.text} </div> ); const App = () => { const [alignment, setAlignment] = useState<TextAlign>('left'); const [color, setColor] = useState(null); const [fontSize, setFontSize] = useState(14); const [lineHeight, setLineHeight] = useState(1.35); const [colorPicker, setColorPicker] = useState(null); const onButtonClick = useCallback((e: ButtonTypes.ClickEvent) => { notify(`Go to ${e.component.option('text')}'s profile`, 'success', 600); }, []); const onItemClick = useCallback((e: DropDownButtonTypes.ItemClickEvent) => { notify(e.itemData.name || e.itemData, 'success', 600); }, []); const onColorClick = useCallback((selectedColor) => { setColor(selectedColor); const squareIcon = colorPicker.element().getElementsByClassName('dx-icon-square')[0]; squareIcon.style.color = selectedColor; colorPicker.close(); }, [colorPicker]); const onInitialized = useCallback((e: DropDownButtonTypes.InitializedEvent) => { setColorPicker(e.component); }, [setColorPicker]); const toolbarItems = useMemo(() => [ { location: 'before', widget: 'dxDropDownButton', options: { displayExpr: 'name', keyExpr: 'id', selectedItemKey: 3, width: 125, stylingMode: 'text', useSelectMode: true, onSelectionChanged: (e) => { setAlignment(e.item.name.toLowerCase()); }, items: data.alignments, }, }, { location: 'before', widget: 'dxDropDownButton', options: { items: data.colors, icon: 'square', stylingMode: 'text', dropDownOptions: { width: 'auto' }, onInitialized, dropDownContentTemplate: 'colorpicker', }, }, { location: 'before', widget: 'dxDropDownButton', options: { stylingMode: 'text', displayExpr: 'text', keyExpr: 'size', useSelectMode: true, items: data.fontSizes, selectedItemKey: 14, onSelectionChanged: (e: DropDownButtonTypes.SelectionChangedEvent) => { setFontSize(e.item.size); }, itemTemplate: 'fontItem', }, }, { location: 'before', widget: 'dxDropDownButton', options: { stylingMode: 'text', icon: 'indent', displayExpr: 'text', keyExpr: 'lineHeight', useSelectMode: true, items: data.lineHeights, selectedItemKey: 1.35, onSelectionChanged: (e: DropDownButtonTypes.SelectionChangedEvent) => { setLineHeight(e.item.lineHeight); }, }, }, ], [setAlignment, setFontSize, setLineHeight, onInitialized]); return ( <div> <div className="dx-fieldset"> <div className="dx-fieldset-header">Single usage</div> <div className="dx-field"> <div className="dx-field-label"> Custom static text </div> <div className="dx-field-value"> <DropDownButton text="Download Trial" icon="save" dropDownOptions={buttonDropDownOptions} items={data.downloads} onItemClick={onItemClick} /> </div> </div> <div className="dx-field"> <div className="dx-field-label"> Custom main button action </div> <div className="dx-field-value"> <DropDownButton splitButton={true} useSelectMode={false} text="Sandra Johnson" icon="../../../../images/gym/coach-woman.png" items={data.profileSettings} displayExpr="name" keyExpr="id" onButtonClick={onButtonClick} onItemClick={onItemClick} /> </div> </div> </div> <div className="dx-fieldset"> <div className="dx-fieldset-header">Usage in a toolbar</div> <div className="dx-field"> <Toolbar items={toolbarItems}> <Template name="colorpicker"> <div className="custom-color-picker"> {data.colors.map((colorValue, i) => ( <ColorIcon key={i} color={colorValue} onClick={onColorClick} /> ))} </div> </Template> <Template name="fontItem" render={itemTemplateRender}> </Template> </Toolbar> </div> <div className={color ? 'dx-field' : 'dx-field dx-theme-text-color'} style={{ color, textAlign: alignment, lineHeight, fontSize: `${fontSize}px`, }}> <p id="text">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> </div> ); }; export default App;
import React, { useCallback, useMemo, useState } from 'react'; import DropDownButton from 'devextreme-react/drop-down-button'; import Toolbar from 'devextreme-react/toolbar'; import { Template } from 'devextreme-react/core/template'; import notify from 'devextreme/ui/notify'; import service from './data.js'; import ColorIcon from './ColorIcon.js'; import 'whatwg-fetch'; const buttonDropDownOptions = { width: 230 }; const data = service.getData(); const itemTemplateRender = (item) => <div style={{ fontSize: `${item.size}px` }}>{item.text}</div>; const App = () => { const [alignment, setAlignment] = useState('left'); const [color, setColor] = useState(null); const [fontSize, setFontSize] = useState(14); const [lineHeight, setLineHeight] = useState(1.35); const [colorPicker, setColorPicker] = useState(null); const onButtonClick = useCallback((e) => { notify(`Go to ${e.component.option('text')}'s profile`, 'success', 600); }, []); const onItemClick = useCallback((e) => { notify(e.itemData.name || e.itemData, 'success', 600); }, []); const onColorClick = useCallback( (selectedColor) => { setColor(selectedColor); const squareIcon = colorPicker.element().getElementsByClassName('dx-icon-square')[0]; squareIcon.style.color = selectedColor; colorPicker.close(); }, [colorPicker], ); const onInitialized = useCallback( (e) => { setColorPicker(e.component); }, [setColorPicker], ); const toolbarItems = useMemo( () => [ { location: 'before', widget: 'dxDropDownButton', options: { displayExpr: 'name', keyExpr: 'id', selectedItemKey: 3, width: 125, stylingMode: 'text', useSelectMode: true, onSelectionChanged: (e) => { setAlignment(e.item.name.toLowerCase()); }, items: data.alignments, }, }, { location: 'before', widget: 'dxDropDownButton', options: { items: data.colors, icon: 'square', stylingMode: 'text', dropDownOptions: { width: 'auto' }, onInitialized, dropDownContentTemplate: 'colorpicker', }, }, { location: 'before', widget: 'dxDropDownButton', options: { stylingMode: 'text', displayExpr: 'text', keyExpr: 'size', useSelectMode: true, items: data.fontSizes, selectedItemKey: 14, onSelectionChanged: (e) => { setFontSize(e.item.size); }, itemTemplate: 'fontItem', }, }, { location: 'before', widget: 'dxDropDownButton', options: { stylingMode: 'text', icon: 'indent', displayExpr: 'text', keyExpr: 'lineHeight', useSelectMode: true, items: data.lineHeights, selectedItemKey: 1.35, onSelectionChanged: (e) => { setLineHeight(e.item.lineHeight); }, }, }, ], [setAlignment, setFontSize, setLineHeight, onInitialized], ); return ( <div> <div className="dx-fieldset"> <div className="dx-fieldset-header">Single usage</div> <div className="dx-field"> <div className="dx-field-label">Custom static text</div> <div className="dx-field-value"> <DropDownButton text="Download Trial" icon="save" dropDownOptions={buttonDropDownOptions} items={data.downloads} onItemClick={onItemClick} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Custom main button action</div> <div className="dx-field-value"> <DropDownButton splitButton={true} useSelectMode={false} text="Sandra Johnson" icon="../../../../images/gym/coach-woman.png" items={data.profileSettings} displayExpr="name" keyExpr="id" onButtonClick={onButtonClick} onItemClick={onItemClick} /> </div> </div> </div> <div className="dx-fieldset"> <div className="dx-fieldset-header">Usage in a toolbar</div> <div className="dx-field"> <Toolbar items={toolbarItems}> <Template name="colorpicker"> <div className="custom-color-picker"> {data.colors.map((colorValue, i) => ( <ColorIcon key={i} color={colorValue} onClick={onColorClick} /> ))} </div> </Template> <Template name="fontItem" render={itemTemplateRender} ></Template> </Toolbar> </div> <div className={color ? 'dx-field' : 'dx-field dx-theme-text-color'} style={{ color, textAlign: alignment, lineHeight, fontSize: `${fontSize}px`, }} > <p id="text"> 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> </div> ); }; export default App;
import React from 'react'; interface ColorIconProps { key: number; color: string; // eslint-disable-next-line no-unused-vars onClick: (string)=>void; } class ColorIcon extends React.Component<ColorIconProps> { constructor(props) { super(props); this.onClick = this.onClick.bind(this); } onClick() { this.props.onClick(this.props.color); } render() { return ( <i onClick={this.onClick} className={this.props.color ? 'color dx-icon dx-icon-square' : 'color dx-icon dx-icon-square dx-theme-text-color'} style={{ color: this.props.color }} /> ); } } export default ColorIcon;
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render( <App />, document.getElementById('app'), );
const colors = [null, '#980000', '#ff0000', '#ff9900', '#ffff00', '#00ff00', '#00ffff', '#4a86e8', '#0000ff', '#9900ff', '#ff00ff', '#ff3466']; const profileSettings = [ { id: 1, name: 'Profile', icon: 'user' }, { id: 4, name: 'Messages', icon: 'email', badge: '5', }, { id: 2, name: 'Friends', icon: 'group' }, { id: 3, name: 'Exit', icon: 'runner' }, ]; const downloads = ['Download Trial For Visual Studio', 'Download Trial For All Platforms', 'Package Managers']; const alignments = [ { id: 1, name: 'Left', icon: 'alignleft' }, { id: 4, name: 'Right', icon: 'alignright' }, { id: 2, name: 'Center', icon: 'aligncenter' }, { id: 3, name: 'Justify', icon: 'alignjustify' }, ]; const fontSizes = [ { size: 10, text: '10px' }, { size: 12, text: '12px' }, { size: 14, text: '14px' }, { size: 16, text: '16px' }, { size: 18, text: '18px' }, ]; const lineHeights = [ { lineHeight: 1, text: '1' }, { lineHeight: 1.35, text: '1.35' }, { lineHeight: 1.5, text: '1.5' }, { lineHeight: 2, text: '2' }, ]; export default { getData() { return { colors, profileSettings, downloads, alignments, fontSizes, lineHeights, }; }, };
window.exports = window.exports || {}; window.config = { transpiler: 'ts', typescriptOptions: { module: 'system', emitDecoratorMetadata: true, experimentalDecorators: true, jsx: 'react', }, meta: { 'react': { 'esModule': true, }, 'typescript': { 'exports': 'ts', }, 'devextreme/time_zone_utils.js': { 'esModule': true, }, 'devextreme/localization.js': { 'esModule': true, }, 'devextreme/viz/palette.js': { 'esModule': true, }, }, paths: { 'npm:': 'https://unpkg.com/', }, defaultExtension: 'js', map: { 'ts': 'npm:plugin-typescript@4.2.4/lib/plugin.js', 'typescript': 'npm:typescript@4.2.4/lib/typescript.js', 'react': 'npm:react@17.0.2/umd/react.development.js', 'react-dom': 'npm:react-dom@17.0.2/umd/react-dom.development.js', 'prop-types': 'npm:prop-types@15.8.1/prop-types.js', 'whatwg-fetch': 'npm:whatwg-fetch@2.0.4/fetch.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.2.5/cjs', 'devextreme-react': 'npm:devextreme-react@23.2.5/cjs', 'jszip': 'npm:jszip@3.10.1/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.6.4/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.2.5/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@4.1.51/dist/dx-gantt.js', '@devextreme/runtime': 'npm:@devextreme/runtime@3.0.12', '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', 'devextreme-cldr-data': 'npm:devextreme-cldr-data@1.0.3', // SystemJS plugins 'plugin-babel': 'npm:systemjs-plugin-babel@0.0.25/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0.0.25/systemjs-babel-browser.js', // Prettier 'prettier/standalone': 'npm:prettier@2.8.4/standalone.js', 'prettier/parser-html': 'npm:prettier@2.8.4/parser-html.js', }, packages: { 'devextreme': { defaultExtension: 'js', }, 'devextreme-react': { main: 'index.js', }, 'devextreme/events/utils': { main: 'index', }, 'devextreme/localization/messages': { format: 'json', defaultExtension: '', }, 'devextreme/events': { main: 'index', }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js', }, }, packageConfigPaths: [ 'npm:@devextreme/*/package.json', 'npm:@devextreme/runtime@3.0.12/inferno/package.json', ], babelOptions: { sourceMaps: false, stage0: true, react: true, }, }; System.config(window.config);
import React from 'react'; class ColorIcon extends React.Component { constructor(props) { super(props); this.onClick = this.onClick.bind(this); } onClick() { this.props.onClick(this.props.color); } render() { return ( <i onClick={this.onClick} className={ this.props.color ? 'color dx-icon dx-icon-square' : 'color dx-icon dx-icon-square dx-theme-text-color' } style={{ color: this.props.color }} /> ); } } export default ColorIcon;
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));
const colors = [ null, '#980000', '#ff0000', '#ff9900', '#ffff00', '#00ff00', '#00ffff', '#4a86e8', '#0000ff', '#9900ff', '#ff00ff', '#ff3466', ]; const profileSettings = [ { id: 1, name: 'Profile', icon: 'user' }, { id: 4, name: 'Messages', icon: 'email', badge: '5', }, { id: 2, name: 'Friends', icon: 'group' }, { id: 3, name: 'Exit', icon: 'runner' }, ]; const downloads = [ 'Download Trial For Visual Studio', 'Download Trial For All Platforms', 'Package Managers', ]; const alignments = [ { id: 1, name: 'Left', icon: 'alignleft' }, { id: 4, name: 'Right', icon: 'alignright' }, { id: 2, name: 'Center', icon: 'aligncenter' }, { id: 3, name: 'Justify', icon: 'alignjustify' }, ]; const fontSizes = [ { size: 10, text: '10px' }, { size: 12, text: '12px' }, { size: 14, text: '14px' }, { size: 16, text: '16px' }, { size: 18, text: '18px' }, ]; const lineHeights = [ { lineHeight: 1, text: '1' }, { lineHeight: 1.35, text: '1.35' }, { lineHeight: 1.5, text: '1.5' }, { lineHeight: 2, text: '2' }, ]; export default { getData() { return { colors, profileSettings, downloads, alignments, fontSizes, lineHeights, }; }, };
<!DOCTYPE html> <html> <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="https://cdn3.devexpress.com/jslib/23.2.5/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="https://unpkg.com/core-js@2.6.12/client/shim.min.js"></script> <script src="https://unpkg.com/systemjs@0.21.3/dist/system.js"></script> <script type="text/javascript" src="config.js"></script> <script type="text/javascript"> System.import("./index.tsx"); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"></div> </div> </body> </html>
.demo-container .dx-fieldset:first-child { width: 500px; } .custom-color-picker { width: 82px; padding: 5px; } .dx-button-content img.dx-icon { width: 24px; height: 24px; } .color { cursor: pointer; font-size: 18px; }