DevExtreme v23.2 is now available.

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

Your search did not match any results.

Overview

The TagBox component allows users to select multiple items from a drop-down list. This demo illustrates the following TagBox properties:

  • items
    An array of items to display in the drop-down list. Do not use the items property and the dataSource property in the same configuration.

  • dataSource
    Binds the TagBox to a data source, which allows you to perform complex data operations. Do not use the dataSource property and the items property in the same configuration.

  • searchEnabled
    Enables interactive item search.

  • showSelectionControls
    Enables item selection controls.

  • applyValueMode
    Specifies whether TagBox applies the selection instantly or after a confirmation.

  • hideSelectedItems
    Specifies whether TagBox removes selected items from the drop-down list.

  • multiline
    Specifies whether TagBox enables horizontal scrolling when the input field cannot fit all selected items.

  • acceptCustomValue
    Allows users to enter custom values. To enable this capability, implement the onCustomItemCreating handler.

  • placeholder
    Sets the value of the placeholder string.

  • value
    Specifies the list of currently selected items.

  • disabled
    Specifies whether the component responds to user interaction.

  • itemTemplate
    Allows you to customize the appearance and content of list items.

  • tagTemplate Allows you to customize the appearance and content of list item tooltips.

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

Backend API
import React, { useCallback, useState } from 'react'; import TagBox, { TagBoxTypes } from 'devextreme-react/tag-box'; import Popover from 'devextreme-react/popover'; import ArrayStore from 'devextreme/data/array_store'; import Item from './Item.tsx'; import Tag from './Tag.tsx'; import { simpleProducts, products, productLabel, Product, } from './data.ts'; const disabledValue = [simpleProducts[0]]; const value = [1, 2]; const dataSource = new ArrayStore({ data: products, key: 'Id', }); function App() { const [editableProducts, setEditableProducts] = useState([...simpleProducts]); const [target, setTarget] = useState(null); const [product, setProduct] = useState<Product>({}); const onCustomItemCreating = useCallback( (args: TagBoxTypes.CustomItemCreatingEvent) => { const newValue = args.text; const isItemInDataSource = editableProducts.some((item) => item === newValue); if (!isItemInDataSource) { setEditableProducts([newValue, ...editableProducts]); } args.customItem = newValue; }, [editableProducts], ); const onMouseEnter = useCallback((e: { currentTarget: any }, newProduct) => { setTarget(e.currentTarget); setProduct(newProduct); }, []); return ( <React.Fragment> <div className="dx-fieldset"> <div className="dx-field"> <div className="dx-field-label">Default mode</div> <div className="dx-field-value"> <TagBox items={simpleProducts} inputAttr={productLabel} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Search mode</div> <div className="dx-field-value"> <TagBox items={simpleProducts} searchEnabled={true} inputAttr={productLabel} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Batch selection</div> <div className="dx-field-value"> <TagBox items={simpleProducts} showSelectionControls={true} inputAttr={productLabel} applyValueMode="useButtons" /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Hide selected items</div> <div className="dx-field-value"> <TagBox items={simpleProducts} inputAttr={productLabel} hideSelectedItems={true} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Single line mode</div> <div className="dx-field-value"> <TagBox items={simpleProducts} inputAttr={productLabel} multiline={false} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Add custom items</div> <div className="dx-field-value"> <TagBox items={editableProducts} inputAttr={productLabel} acceptCustomValue={true} onCustomItemCreating={onCustomItemCreating} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">With custom placeholder</div> <div className="dx-field-value"> <TagBox items={simpleProducts} inputAttr={productLabel} placeholder="Choose Product..." /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Disabled</div> <div className="dx-field-value"> <TagBox items={simpleProducts} inputAttr={productLabel} value={disabledValue} disabled={true} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Data source</div> <div className="dx-field-value"> <TagBox dataSource={dataSource} inputAttr={productLabel} displayExpr="Name" valueExpr="Id" /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Custom template</div> <div className="dx-field-value"> <TagBox dataSource={dataSource} defaultValue={value} inputAttr={productLabel} displayExpr="Name" valueExpr="Id" itemRender={Item} tagRender={(data) => ( <Tag product={data} onMouseEnter={onMouseEnter} /> )} /> <Popover showEvent="mouseenter" hideEvent="mouseleave" target={target} > <p> <b>Name: </b> <span>{product.Name}</span> </p> <p> <b>Price: </b> <span>{product.Price}</span> </p> <p> <b>In-stock: </b> <span>{product.Current_Inventory}</span> </p> <p> <b>Category: </b> <span>{product.Category}</span> </p> </Popover> </div> </div> </div> </React.Fragment> ); } export default App;
import React, { useCallback, useState } from 'react'; import TagBox from 'devextreme-react/tag-box'; import Popover from 'devextreme-react/popover'; import ArrayStore from 'devextreme/data/array_store'; import Item from './Item.js'; import Tag from './Tag.js'; import { simpleProducts, products, productLabel } from './data.js'; const disabledValue = [simpleProducts[0]]; const value = [1, 2]; const dataSource = new ArrayStore({ data: products, key: 'Id', }); function App() { const [editableProducts, setEditableProducts] = useState([...simpleProducts]); const [target, setTarget] = useState(null); const [product, setProduct] = useState({}); const onCustomItemCreating = useCallback( (args) => { const newValue = args.text; const isItemInDataSource = editableProducts.some((item) => item === newValue); if (!isItemInDataSource) { setEditableProducts([newValue, ...editableProducts]); } args.customItem = newValue; }, [editableProducts], ); const onMouseEnter = useCallback((e, newProduct) => { setTarget(e.currentTarget); setProduct(newProduct); }, []); return ( <React.Fragment> <div className="dx-fieldset"> <div className="dx-field"> <div className="dx-field-label">Default mode</div> <div className="dx-field-value"> <TagBox items={simpleProducts} inputAttr={productLabel} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Search mode</div> <div className="dx-field-value"> <TagBox items={simpleProducts} searchEnabled={true} inputAttr={productLabel} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Batch selection</div> <div className="dx-field-value"> <TagBox items={simpleProducts} showSelectionControls={true} inputAttr={productLabel} applyValueMode="useButtons" /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Hide selected items</div> <div className="dx-field-value"> <TagBox items={simpleProducts} inputAttr={productLabel} hideSelectedItems={true} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Single line mode</div> <div className="dx-field-value"> <TagBox items={simpleProducts} inputAttr={productLabel} multiline={false} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Add custom items</div> <div className="dx-field-value"> <TagBox items={editableProducts} inputAttr={productLabel} acceptCustomValue={true} onCustomItemCreating={onCustomItemCreating} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">With custom placeholder</div> <div className="dx-field-value"> <TagBox items={simpleProducts} inputAttr={productLabel} placeholder="Choose Product..." /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Disabled</div> <div className="dx-field-value"> <TagBox items={simpleProducts} inputAttr={productLabel} value={disabledValue} disabled={true} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Data source</div> <div className="dx-field-value"> <TagBox dataSource={dataSource} inputAttr={productLabel} displayExpr="Name" valueExpr="Id" /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Custom template</div> <div className="dx-field-value"> <TagBox dataSource={dataSource} defaultValue={value} inputAttr={productLabel} displayExpr="Name" valueExpr="Id" itemRender={Item} tagRender={(data) => ( <Tag product={data} onMouseEnter={onMouseEnter} /> )} /> <Popover showEvent="mouseenter" hideEvent="mouseleave" target={target} > <p> <b>Name: </b> <span>{product.Name}</span> </p> <p> <b>Price: </b> <span>{product.Price}</span> </p> <p> <b>In-stock: </b> <span>{product.Current_Inventory}</span> </p> <p> <b>Category: </b> <span>{product.Category}</span> </p> </Popover> </div> </div> </div> </React.Fragment> ); } export default App;
import React from 'react'; export default function Item(data) { return ( <div className="custom-item"> <img src={data.ImageSrc} /> <div className="product-name">{data.Name}</div> </div> ); }
import React from 'react'; interface TagProps { product: any; onMouseEnter: any; } export default function Tag({ product, onMouseEnter }: TagProps) { const isDisabled = product.Name === 'SuperHD Video Player'; return ( <React.Fragment> <div className={`dx-tag-content ${isDisabled && 'disabled-tag'}`} onMouseEnter={(e) => onMouseEnter(e, product)} aria-disabled={isDisabled} > <img src={product.ImageSrc} className="tag-img" /> <span>{product.Name}</span> {!isDisabled && <div className="dx-tag-remove-button"></div>} </div> </React.Fragment> ); }
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.tsx'; ReactDOM.render(<App />, document.getElementById('app'));
export const simpleProducts = [ 'HD Video Player', 'SuperHD Video Player', 'SuperPlasma 50', 'SuperLED 50', 'SuperLED 42', 'SuperLCD 55', 'SuperLCD 42', 'SuperPlasma 65', 'SuperLCD 70', 'Projector Plus', 'Projector PlusHT', 'ExcelRemote IR', 'ExcelRemote Bluetooth', 'ExcelRemote IP', ]; export type Product = { Id?: number, Name?: string, Price?: number, Current_Inventory?: number, Backorder?: number, Manufacturing?: number, Category?: string, ImageSrc?: string, }; export const products: Product[] = [{ Id: 1, Name: 'HD Video Player', Price: 330, Current_Inventory: 225, Backorder: 0, Manufacturing: 10, Category: 'Video Players', ImageSrc: '../../../../images/products/1.png', }, { Id: 2, Name: 'SuperHD Video Player', Price: 400, Current_Inventory: 150, Backorder: 0, Manufacturing: 25, Category: 'Video Players', ImageSrc: '../../../../images/products/2.png', }, { Id: 3, Name: 'SuperPlasma 50', Price: 2400, Current_Inventory: 0, Backorder: 0, Manufacturing: 0, Category: 'Televisions', ImageSrc: '../../../../images/products/3.png', }, { Id: 4, Name: 'SuperLED 50', Price: 1600, Current_Inventory: 77, Backorder: 0, Manufacturing: 55, Category: 'Televisions', ImageSrc: '../../../../images/products/4.png', }, { Id: 5, Name: 'SuperLED 42', Price: 1450, Current_Inventory: 445, Backorder: 0, Manufacturing: 0, Category: 'Televisions', ImageSrc: '../../../../images/products/5.png', }, { Id: 6, Name: 'SuperLCD 55', Price: 1350, Current_Inventory: 345, Backorder: 0, Manufacturing: 5, Category: 'Televisions', ImageSrc: '../../../../images/products/6.png', }, { Id: 7, Name: 'SuperLCD 42', Price: 1200, Current_Inventory: 210, Backorder: 0, Manufacturing: 20, Category: 'Televisions', ImageSrc: '../../../../images/products/7.png', }, { Id: 8, Name: 'SuperPlasma 65', Price: 3500, Current_Inventory: 0, Backorder: 0, Manufacturing: 0, Category: 'Televisions', ImageSrc: '../../../../images/products/8.png', }, { Id: 9, Name: 'SuperLCD 70', Price: 4000, Current_Inventory: 95, Backorder: 0, Manufacturing: 5, Category: 'Televisions', ImageSrc: '../../../../images/products/9.png', }, { Id: 10, Name: 'DesktopLED 21', Price: 175, Current_Inventory: null, Backorder: 425, Manufacturing: 75, Category: 'Monitors', ImageSrc: '../../../../images/products/10.png', }, { Id: 12, Name: 'DesktopLCD 21', Price: 170, Current_Inventory: 210, Backorder: 0, Manufacturing: 60, Category: 'Monitors', ImageSrc: '../../../../images/products/12.png', }, { Id: 13, Name: 'DesktopLCD 19', Price: 160, Current_Inventory: 150, Backorder: 0, Manufacturing: 210, Category: 'Monitors', ImageSrc: '../../../../images/products/13.png', }, { Id: 14, Name: 'Projector Plus', Price: 550, Current_Inventory: null, Backorder: 55, Manufacturing: 10, Category: 'Projectors', ImageSrc: '../../../../images/products/14.png', }, { Id: 15, Name: 'Projector PlusHD', Price: 750, Current_Inventory: 110, Backorder: 0, Manufacturing: 90, Category: 'Projectors', ImageSrc: '../../../../images/products/15.png', }, { Id: 16, Name: 'Projector PlusHT', Price: 1050, Current_Inventory: 0, Backorder: 75, Manufacturing: 57, Category: 'Projectors', ImageSrc: '../../../../images/products/16.png', }, { Id: 17, Name: 'ExcelRemote IR', Price: 150, Current_Inventory: 650, Backorder: 0, Manufacturing: 190, Category: 'Automation', ImageSrc: '../../../../images/products/17.png', }, { Id: 18, Name: 'ExcelRemote Bluetooth', Price: 180, Current_Inventory: 310, Backorder: 0, Manufacturing: 0, Category: 'Automation', ImageSrc: '../../../../images/products/18.png', }, { Id: 19, Name: 'ExcelRemote IP', Price: 200, Current_Inventory: 0, Backorder: 325, Manufacturing: 225, Category: 'Automation', ImageSrc: '../../../../images/products/19.png', }]; export const productLabel = { 'aria-label': 'Product' };
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', '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'; export default function Item(data) { return ( <div className="custom-item"> <img src={data.ImageSrc} /> <div className="product-name">{data.Name}</div> </div> ); }
import React from 'react'; export default function Tag({ product, onMouseEnter }) { const isDisabled = product.Name === 'SuperHD Video Player'; return ( <React.Fragment> <div className={`dx-tag-content ${isDisabled && 'disabled-tag'}`} onMouseEnter={(e) => onMouseEnter(e, product)} aria-disabled={isDisabled} > <img src={product.ImageSrc} className="tag-img" /> <span>{product.Name}</span> {!isDisabled && <div className="dx-tag-remove-button"></div>} </div> </React.Fragment> ); }
import React from 'react'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render(<App />, document.getElementById('app'));
export const simpleProducts = [ 'HD Video Player', 'SuperHD Video Player', 'SuperPlasma 50', 'SuperLED 50', 'SuperLED 42', 'SuperLCD 55', 'SuperLCD 42', 'SuperPlasma 65', 'SuperLCD 70', 'Projector Plus', 'Projector PlusHT', 'ExcelRemote IR', 'ExcelRemote Bluetooth', 'ExcelRemote IP', ]; export const products = [ { Id: 1, Name: 'HD Video Player', Price: 330, Current_Inventory: 225, Backorder: 0, Manufacturing: 10, Category: 'Video Players', ImageSrc: '../../../../images/products/1.png', }, { Id: 2, Name: 'SuperHD Video Player', Price: 400, Current_Inventory: 150, Backorder: 0, Manufacturing: 25, Category: 'Video Players', ImageSrc: '../../../../images/products/2.png', }, { Id: 3, Name: 'SuperPlasma 50', Price: 2400, Current_Inventory: 0, Backorder: 0, Manufacturing: 0, Category: 'Televisions', ImageSrc: '../../../../images/products/3.png', }, { Id: 4, Name: 'SuperLED 50', Price: 1600, Current_Inventory: 77, Backorder: 0, Manufacturing: 55, Category: 'Televisions', ImageSrc: '../../../../images/products/4.png', }, { Id: 5, Name: 'SuperLED 42', Price: 1450, Current_Inventory: 445, Backorder: 0, Manufacturing: 0, Category: 'Televisions', ImageSrc: '../../../../images/products/5.png', }, { Id: 6, Name: 'SuperLCD 55', Price: 1350, Current_Inventory: 345, Backorder: 0, Manufacturing: 5, Category: 'Televisions', ImageSrc: '../../../../images/products/6.png', }, { Id: 7, Name: 'SuperLCD 42', Price: 1200, Current_Inventory: 210, Backorder: 0, Manufacturing: 20, Category: 'Televisions', ImageSrc: '../../../../images/products/7.png', }, { Id: 8, Name: 'SuperPlasma 65', Price: 3500, Current_Inventory: 0, Backorder: 0, Manufacturing: 0, Category: 'Televisions', ImageSrc: '../../../../images/products/8.png', }, { Id: 9, Name: 'SuperLCD 70', Price: 4000, Current_Inventory: 95, Backorder: 0, Manufacturing: 5, Category: 'Televisions', ImageSrc: '../../../../images/products/9.png', }, { Id: 10, Name: 'DesktopLED 21', Price: 175, Current_Inventory: null, Backorder: 425, Manufacturing: 75, Category: 'Monitors', ImageSrc: '../../../../images/products/10.png', }, { Id: 12, Name: 'DesktopLCD 21', Price: 170, Current_Inventory: 210, Backorder: 0, Manufacturing: 60, Category: 'Monitors', ImageSrc: '../../../../images/products/12.png', }, { Id: 13, Name: 'DesktopLCD 19', Price: 160, Current_Inventory: 150, Backorder: 0, Manufacturing: 210, Category: 'Monitors', ImageSrc: '../../../../images/products/13.png', }, { Id: 14, Name: 'Projector Plus', Price: 550, Current_Inventory: null, Backorder: 55, Manufacturing: 10, Category: 'Projectors', ImageSrc: '../../../../images/products/14.png', }, { Id: 15, Name: 'Projector PlusHD', Price: 750, Current_Inventory: 110, Backorder: 0, Manufacturing: 90, Category: 'Projectors', ImageSrc: '../../../../images/products/15.png', }, { Id: 16, Name: 'Projector PlusHT', Price: 1050, Current_Inventory: 0, Backorder: 75, Manufacturing: 57, Category: 'Projectors', ImageSrc: '../../../../images/products/16.png', }, { Id: 17, Name: 'ExcelRemote IR', Price: 150, Current_Inventory: 650, Backorder: 0, Manufacturing: 190, Category: 'Automation', ImageSrc: '../../../../images/products/17.png', }, { Id: 18, Name: 'ExcelRemote Bluetooth', Price: 180, Current_Inventory: 310, Backorder: 0, Manufacturing: 0, Category: 'Automation', ImageSrc: '../../../../images/products/18.png', }, { Id: 19, Name: 'ExcelRemote IP', Price: 200, Current_Inventory: 0, Backorder: 325, Manufacturing: 225, Category: 'Automation', ImageSrc: '../../../../images/products/19.png', }, ]; export const productLabel = { 'aria-label': 'Product' };
<!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>
body .custom-item { padding-left: 7px; padding-right: 7px; } .custom-item > img { height: 30px; width: 40px; float: left; margin-top: 2px; } .custom-item > div.product-name { margin-left: 40px; line-height: 34px; font-size: 14px; } body .custom-item input { background-color: transparent; } body .dx-popup-content .custom-item { padding-top: 7px; padding-bottom: 8px; } .dx-popup-content .custom-item > div { padding-left: 8px; text-indent: 0; text-overflow: ellipsis; overflow: hidden; } .dx-tag-content { display: flex; align-items: center; } .tag-img { height: 30px; margin-right: 5px; } .dx-tag-content.disabled-tag { padding-right: 6px; opacity: 0.5; cursor: not-allowed; }