JavaScript/jQuery Tag Box - Grouping

The JavaScript TagBox component can arrange items into a two-level parent-child hierarchy. To group items, set the grouped property to true.

Was this demo helpful?

Thank you!

Feel free to share demo-related thoughts here.
If you have technical questions, please create a support ticket in the DevExpress Support Center.

Thank you for the feedback!

Backend API

$(() => { const products = new DevExpress.data.DataSource({ store: productsData, key: 'id', group: 'Category', }); $('#TagBox').dxTagBox({ dataSource: products, valueExpr: 'ID', value: [productsData[16].ID, productsData[18].ID], grouped: true, displayExpr: 'Name', inputAttr: { 'aria-label': 'Name' }, }); $('#TagBoxSearch').dxTagBox({ dataSource: products, valueExpr: 'ID', inputAttr: { 'aria-label': 'Name' }, value: [productsData[16].ID, productsData[18].ID], searchEnabled: true, grouped: true, displayExpr: 'Name', }); $('#TagBoxTemplate').dxTagBox({ dataSource: products, valueExpr: 'ID', value: [productsData[17].ID], grouped: true, inputAttr: { 'aria-label': 'Name' }, groupTemplate(data) { return $(`<div class='custom-icon'><span class='dx-icon-box icon'></span> ${data.key}</div>`); }, displayExpr: 'Name', }); });

<!DOCTYPE html> <html xmlns="http://www.w3.org/1999/xhtml" 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" /> <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.5.1/jquery.min.js"></script> <script>window.jQuery || document.write(decodeURIComponent('%3Cscript src="js/jquery.min.js"%3E%3C/script%3E'))</script> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/25.1.3/css/dx.light.css" /> <script src="js/dx.all.js"></script> <script src="data.js"></script> <link rel="stylesheet" type="text/css" href="styles.css" /> <script src="index.js"></script> </head> <body class="dx-viewport"> <div class="demo-container"> <div class="dx-fieldset"> <div class="dx-field"> <div class="dx-field-label">Grouped items</div> <div class="dx-field-value"> <div id="TagBox"></div> </div> </div> <div class="dx-field"> <div class="dx-field-label">Grouped items with search enabled</div> <div class="dx-field-value"> <div id="TagBoxSearch"></div> </div> </div> <div class="dx-field"> <div class="dx-field-label">Grouped items with a custom group template</div> <div class="dx-field-value"> <div id="TagBoxTemplate"></div> </div> </div> </div> </div> </body> </html>

.custom-icon .icon { color: #f05b41; } .custom-icon { display: flex; align-items: center; gap: 4px; } .dx-field { margin-bottom: 50px; }

const productsData = [{ 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', }];

Ensure the data source defines the hierarchy in one of the following ways:

Grouping Field
The data source can contain a plain array of objects with multiple fields. Assign a field to the DataSource's group property to create a hierarchical display. Parent items display unique values from the specified field, and Child items display grouped values. This demo shows how to use this data source type.
Hierarchical Data Source Structure
You can use a dataSource where each entry is an object that contains the key and items fields. The key field specifies the group header (parent), and the items field holds an array of child items. A data source can specify different field names if the data is structured in the same way. In this case, implement the DataSource's map function to create key and items field mappings. Refer to the following help topic for more information: Item Mapping.

This demo also shows how to customize the appearance of group headers (the groupTemplate property) and enable search (the searchEnabled property).