Your search did not match any results.
Select Box

Grouped Items

Data items in the SelectBox's drop-down list can be organized in groups.

If the data source provides data items ungrouped, use the DataSource's group option to specify the data field to group by. This case is illustrated in this demo.

The SelectBox can also work with initially grouped data items. In this case, the data array should contain objects with the key and items fields:

let dataSource = [{
    key: "Group 1", // Group caption 
    items: [ // Items in Group 1
        { /* ... */ },
        { /* ... */ }
    ]
}, {
    key: "Group 2",
    items: [
        { /* ... */ },
        { /* ... */ }
    ]
}];

If data objects are grouped but use other field names, implement the DataSource's map function to create key + items field mappings.

NOTE

Subgroups are not supported.

Copy to CodeSandBox
Apply
Reset
<template> <div class="dx-fieldset"> <div class="dx-field"> <div class="dx-field-label">Data grouped in the DataSource</div> <div class="dx-field-value"> <DxSelectBox :data-source="fromUngroupedData" :grouped="true" display-expr="Name" value-expr="ID" /> </div> </div> <div class="dx-field"> <div class="dx-field-label">Pre-grouped data</div> <div class="dx-field-value"> <DxSelectBox :data-source="fromPregroupedData" :grouped="true" display-expr="Name" value-expr="ID" /> </div> </div> <div class="dx-field"> <div class="dx-field-label">Custom group template</div> <div class="dx-field-value"> <DxSelectBox :data-source="fromUngroupedData" :grouped="true" display-expr="Name" value-expr="ID" > <template #group="{ data }"> <group :item-data="data"/> </template> </DxSelectBox> </div> </div> </div> </template> <script> import { DxSelectBox } from 'devextreme-vue/select-box'; import DataSource from 'devextreme/data/data_source'; import Group from './Group.vue'; import { ungroupedData, pregroupedData } from './data.js'; export default { components: { DxSelectBox, Group }, data() { return { fromUngroupedData: new DataSource({ store: ungroupedData, key: 'ID', group: 'Category' }), fromPregroupedData: new DataSource({ store: pregroupedData, map: function(item) { item.key = item.Category; item.items = item.Products; return item; } }) }; } }; </script>
<template> <div class="custom-icon"> <span class="dx-icon-box icon"/> {{ itemData.key }} </div> </template> <script> export default { props: { itemData: { type: Object, default: () => {} } } }; </script> <style scoped> .custom-icon .icon { font-size: 17px; color: #f05b41; margin-right: 2px; } </style>
import Vue from 'vue'; import App from './App.vue'; new Vue({ el: '#app', components: { App }, template: '<App/>' });
<!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/19.1.7/css/dx.common.css" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/19.1.7/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="https://maxcdn.bootstrapcdn.com/font-awesome/4.6.3/css/font-awesome.min.css" /> <script src="https://unpkg.com/core-js@2.4.1/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.js'); </script> </head> <body class="dx-viewport"> <div class="demo-container"> <div id="app"> <span v-if="false">Loading...</span> </div> </div> </body> </html>
export const ungroupedData = [{ 'ID': 1, 'Name': 'HD Video Player', 'Category': 'Video Players' }, { 'ID': 2, 'Name': 'SuperHD Player', 'Category': 'Video Players' }, { 'ID': 3, 'Name': 'SuperPlasma 50', 'Category': 'Televisions' }, { 'ID': 4, 'Name': 'SuperLED 50', 'Category': 'Televisions' }, { 'ID': 5, 'Name': 'SuperLED 42', 'Category': 'Televisions' }, { 'ID': 6, 'Name': 'SuperLCD 55', 'Category': 'Televisions' }, { 'ID': 7, 'Name': 'SuperLCD 42', 'Category': 'Televisions' }, { 'ID': 8, 'Name': 'SuperPlasma 65', 'Category': 'Televisions' }, { 'ID': 9, 'Name': 'SuperLCD 70', 'Category': 'Televisions' }, { 'ID': 10, 'Name': 'DesktopLED 21', 'Category': 'Monitors' }, { 'ID': 11, 'Name': 'DesktopLED 19', 'Category': 'Monitors' }, { 'ID': 12, 'Name': 'DesktopLCD 21', 'Category': 'Monitors' }, { 'ID': 13, 'Name': 'DesktopLCD 19', 'Category': 'Monitors' }, { 'ID': 14, 'Name': 'Projector Plus', 'Category': 'Projectors' }, { 'ID': 15, 'Name': 'Projector PlusHD', 'Category': 'Projectors' }, { 'ID': 16, 'Name': 'Projector PlusHT', 'Category': 'Projectors' }, { 'ID': 17, 'Name': 'ExcelRemote IR', 'Category': 'Automation' }, { 'ID': 18, 'Name': 'ExcelRemote BT', 'Category': 'Automation' }, { 'ID': 19, 'Name': 'ExcelRemote IP', 'Category': 'Automation' }]; export const pregroupedData = [{ 'Category': 'Video Players', 'Products': [{ 'ID': 1, 'Name': 'HD Video Player' }, { 'ID': 2, 'Name': 'SuperHD Player' }], }, { 'Category': 'Televisions', 'Products': [{ 'ID': 3, 'Name': 'SuperPlasma 50' }, { 'ID': 4, 'Name': 'SuperLED 50' }, { 'ID': 5, 'Name': 'SuperLED 42' }, { 'ID': 6, 'Name': 'SuperLCD 55' }, { 'ID': 7, 'Name': 'SuperLCD 42' }, { 'ID': 8, 'Name': 'SuperPlasma 65' }, { 'ID': 9, 'Name': 'SuperLCD 70' }] }, { 'Category': 'Monitors', 'Products': [{ 'ID': 10, 'Name': 'DesktopLED 21' }, { 'ID': 11, 'Name': 'DesktopLED 19' }, { 'ID': 12, 'Name': 'DesktopLCD 21' }, { 'ID': 13, 'Name': 'DesktopLCD 19' }] }, { 'Category': 'Projectors', 'Products': [{ 'ID': 14, 'Name': 'Projector Plus' }, { 'ID': 15, 'Name': 'Projector PlusHD' }, { 'ID': 16, 'Name': 'Projector PlusHT' }] }, { 'Category': 'Automation', 'Products': [{ 'ID': 17, 'Name': 'ExcelRemote IR' }, { 'ID': 18, 'Name': 'ExcelRemote BT' }, { 'ID': 19, 'Name': 'ExcelRemote IP' }] }];
System.config({ transpiler: 'plugin-babel', paths: { 'npm:': 'https://unpkg.com/' }, map: { vue: 'npm:vue@2.6.3/dist/vue.esm.browser.js', 'vue-loader': 'npm:dx-systemjs-vue-browser@latest/index.js', 'devextreme': 'npm:devextreme@19.1', 'devextreme-vue': 'npm:devextreme-vue@19.1', jszip: 'npm:jszip@3.1.3/dist/jszip.min.js', 'quill': 'npm:quill@1.3.7/dist/quill.js', 'devexpress-diagram': 'npm:devexpress-diagram', 'plugin-babel': 'npm:systemjs-plugin-babel@0/plugin-babel.js', 'systemjs-babel-build': 'npm:systemjs-plugin-babel@0/systemjs-babel-browser.js' }, meta: { '*.vue': { loader: 'vue-loader' } }, packages: { 'devextreme-vue': { main: 'index.js' }, 'devextreme': { defaultExtension: 'js' } }, babelOptions: { sourceMaps: false, stage0: true } });