Your search did not match any results.
Tag Box

Overview

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

  • items
    An array of items displayed by the TagBox.

  • searchEnabled
    Specifies whether the search is enabled.

  • showSelectionControls
    Defines whether to display the selection controls.

  • applyValueMode
    Specifies whether selected values are applied instantly or when a user clicks the OK button.

  • hideSelectedItems
    Specifies whether the selected items are removed from the drop-down list.

  • multiline
    Displays selected items on single or multiple lines.

  • acceptCustomValue
    Specifies whether users can enter custom values. Requires that you also implement the onCustomItemCreating handler.

  • placeholder
    Customizes the TagBox placeholder.

  • value
    Specifies items the TagBox currently displays.

  • disabled
    Defines whether the component responds to user interaction.

  • dataSource
    Binds the TagBox to data. Unlike the items property, dataSource accepts the DataSource object that allows users to sort, filter, group, and shape data. Note that you cannot use items and dataSource simultaneously.

  • itemTemplate
    Allows you to customize the drop-down list items.

Copy to CodeSandBox
Apply
Reset
import React from 'react'; import TagBox from 'devextreme-react/tag-box'; import ArrayStore from 'devextreme/data/array_store'; import Item from './Item.js'; import { simpleProducts, products } from './data.js'; class App extends React.Component { constructor() { super(); this.dataSource = new ArrayStore({ data: products, key: 'Id' }); this.state = { editableProducts: [...simpleProducts] }; this.onCustomItemCreating = this.onCustomItemCreating.bind(this); } onCustomItemCreating(args) { const newValue = args.text; args.customItem = newValue; this.setState({ editableProducts: [newValue, ...this.state.editableProducts] }); } render() { 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} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Search mode</div> <div className="dx-field-value"> <TagBox items={simpleProducts} searchEnabled={true} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Batch selection</div> <div className="dx-field-value"> <TagBox items={simpleProducts} showSelectionControls={true} 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} 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} multiline={false} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Add custom items</div> <div className="dx-field-value"> <TagBox items={this.state.editableProducts} acceptCustomValue={true} onCustomItemCreating={this.onCustomItemCreating} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">With custom placeholder</div> <div className="dx-field-value"> <TagBox items={simpleProducts} placeholder="Choose Product..." /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Disabled</div> <div className="dx-field-value"> <TagBox items={simpleProducts} value={[simpleProducts[0]]} disabled={true} /> </div> </div> <div className="dx-field"> <div className="dx-field-label">Data source</div> <div className="dx-field-value"> <TagBox dataSource={this.dataSource} 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={this.dataSource} displayExpr="Name" valueExpr="Id" itemRender={Item} /> </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'; import ReactDOM from 'react-dom'; import App from './App.js'; ReactDOM.render( <App />, document.getElementById('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/21.1.4/css/dx.common.css" /> <link rel="stylesheet" type="text/css" href="https://cdn3.devexpress.com/jslib/21.1.4/css/dx.light.css" /> <link rel="stylesheet" type="text/css" href="styles.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"></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; }
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' }];
window.config = { transpiler: 'plugin-babel', meta: { 'devextreme/localization.js': { "esModule": true }, }, paths: { 'npm:': 'https://unpkg.com/' }, defaultExtension: 'js', map: { '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.7.2/prop-types.js', 'rrule': 'npm:rrule@2.6.6/dist/es5/rrule.js', 'luxon': 'npm:luxon@1.27.0/build/global/luxon.min.js', 'es6-object-assign': 'npm:es6-object-assign@1.1.0', 'devextreme': 'npm:devextreme@21.1.4/cjs', 'devextreme-react': 'npm:devextreme-react@21.1.4', 'jszip': 'npm:jszip@3.6.0/dist/jszip.min.js', 'devextreme-quill': 'npm:devextreme-quill@1.1.4/dist/dx-quill.min.js', 'devexpress-diagram': 'npm:devexpress-diagram@2.1.19/dist/dx-diagram.js', 'devexpress-gantt': 'npm:devexpress-gantt@2.1.42/dist/dx-gantt.js', '@devextreme/vdom': 'npm:@devextreme/vdom@1.2.2', 'inferno': 'npm:inferno@7.4.8/dist/inferno.min.js', 'inferno-compat': 'npm:inferno-compat@7.4.8/dist/inferno-compat.min.js', 'inferno-create-element': 'npm:inferno-create-element@7.4.8/dist/inferno-create-element.min.js', 'inferno-dom': 'npm:inferno-dom@1.0.7/dist/inferno-dom.min.js', 'inferno-hydrate': 'npm:inferno-hydrate@7.4.8/dist/inferno-hydrate.min.js', 'inferno-clone-vnode': 'npm:inferno-clone-vnode@7.4.8/dist/inferno-clone-vnode.min.js', 'inferno-create-class': 'npm:inferno-create-class@7.4.8/dist/inferno-create-class.min.js', 'inferno-extras': 'npm:inferno-extras@7.4.8/dist/inferno-extras.min.js', // 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' }, packages: { 'devextreme': { defaultExtension: 'js' }, '@devextreme/vdom': { defaultExtension: 'js' }, 'devextreme-react': { main: 'index.js' }, 'devextreme/events/utils': { main: 'index' }, 'devextreme/events': { main: 'index' }, 'es6-object-assign': { main: './index.js', defaultExtension: 'js' } }, packageConfigPaths: [ "npm:@devextreme/*/package.json", ], babelOptions: { sourceMaps: false, stage0: true, react: true } }; System.config(window.config);