TagBox

The TagBox widget is an editor that allows an end user to select multiple items from a drop-down list.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/tag_box
TagBox interactive configuration
Copy Code
Copy to Codepen
$("#tagbox").dxTagBox({
});

                    

You can create the widget using one of the following approaches.

  • jQuery
    Use the dxTagBox jQuery plug-in.

    HTML
    <div id="tagBox"></div>
    JavaScript
    var tagBoxData = [
        { "name": "Alabama", "capital": "Montgomery" },
        { "name": "Alaska", "capital": "Juneau" },
        { "name": "Arizona", "capital": "Phoenix" }
        . . .
    ]
    $("#tagBox").dxTagBox({
        dataSource: tagBoxData,
        valueExpr: 'capital',
        displayExpr: 'name'
    });
  • Knockout
    Add a div element and apply the dxTagBox binding to this element.

    HTML
    <div data-bind="dxTagBox: {
        dataSource: tagBoxData,
        valueExpr: 'capital',
        displayExpr: 'name'
    }"></div>
  • AngularJS
    Add a div element and apply the dx-tag-box directive to this element.

    HTML
    <div dx-tag-box="{
        dataSource: tagBoxData,
        valueExpr: 'capital',
        displayExpr: 'name'
    }"></div>

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the Installation article.

The TagBox widget supports common Collection Container and Editor widget functionality. You can find detailed information on the principles of working with the widget in the dxTagBox section of the Editor Widgets article. For information on using the Collection Container functionality, refer to the Collection Container Widgets guide.

View Demo

Watch Video

Configuration

An object defining configuration options for the TagBox widget.

Name Description
acceptCustomValue

Specifies whether or not the widget allows an end-user to enter a custom value.

accessKey

Specifies a shortcut key that sets focus on the widget element.

activeStateEnabled

A Boolean value specifying whether or not the widget changes its state when interacting with a user.

applyValueMode

Specifies how the widget applies values.

attr

Specifies HTML attributes applied to the inner input element of the widget.

dataSource

A data source used to fetch data to be displayed by the widget.

deferRendering

Specifies whether widget content is rendered when the widget is shown or when rendering the widget.

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

displayExpr

Specifies the name of the data source item field whose value is displayed by the widget.

fieldTemplate

The template to be used for rendering the widget text field.

focusStateEnabled

Specifies whether or not the widget can be focused.

height

Specifies the height of the widget.

hideSelectedItems

A Boolean value specifying whether or not to hide selected items.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

isValid

Specifies whether the editor's value is valid.

items

An array of items displayed by the widget.

itemTemplate

The template to be used for rendering items.

minSearchLength

The minimum number of characters that must be entered into the text box to begin a search.

multiline

A Boolean value specifying whether or not the widget is multiline.

noDataText

The text or HTML markup displayed by the widget if the item collection is empty.

onChange

A handler for the change event.

onClosed

A handler for the closed event.

onContentReady

A handler for the contentReady event.

onCustomItemCreating

A handler for the customItemCreating event.

onDisposing

A handler for the disposing event.

onEnterKey

A handler for the enterKey event.

onFocusIn

A handler for the focusIn event.

onFocusOut

A handler for the focusOut event.

onInitialized

A handler for the initialized event.

onInput

A handler for the input event.

onItemClick

A handler for the itemClick event.

onKeyDown

A handler for the keyDown event.

onKeyPress

A handler for the keyPress event.

onKeyUp

A handler for the keyUp event.

onOpened

A handler for the opened event.

onOptionChanged

A handler for the optionChanged event.

onSelectAllValueChanged

A handler for the selectAllValueChanged event.

onSelectionChanged

A handler for the selectionChanged event.

onValueChanged

A handler for the valueChanged event.

opened

Specifies whether or not the drop-down editor is displayed.

placeholder

The text that is provided as a hint in the select box editor.

readOnly

A Boolean value specifying whether or not the widget is read-only.

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

searchEnabled

Specifies whether or not the widget supports searching.

searchExpr

Specifies the name of a data source item field or an expression whose value is compared to the search criterion.

searchMode

Specifies the binary operation used to filter data.

searchTimeout

Specifies the time delay, in milliseconds, after the last character has been typed in, before a search is executed.

selectedItems

Gets the currently selected items.

showClearButton

Specifies whether to display the Clear button in the widget.

showDataBeforeSearch

Specifies whether or not the widget displays unfiltered values until a user types a number of characters exceeding the minSearchLength option value.

showSelectionControls

Specifies whether or not to display selection controls.

tabIndex

Specifies the widget tab index.

tagTemplate

The template to be used for rendering tags.

text

The read-only option that holds the text displayed by the widget input element.

validationError

Holds the object that defines the error that occurred during validation.

validationMessageMode

Specifies how the message about the validation rules that are not satisfied by this editor's value is displayed.

value

Specifies the selected items.

valueExpr

Specifies the name of a data source item field whose value is held in the value configuration option.

visible

A Boolean value specifying whether or not the widget is visible.

width

Specifies the width of the widget.

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate() method is called.

blur()

Removes focus from the input element.

close()

Closes the drop-down editor.

content()

Returns an HTML element of the popup window content.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate() method call.

field()

Returns an <input> element of the widget.

focus()

Sets focus to the input element representing the widget.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

open()

Opens the drop-down editor.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

registerKeyHandler(key, handler)

Registers a handler when a specified key is pressed.

repaint()

Redraws the widget.

reset()

Resets the widget's value to null.

Events

This section describes events fired by this widget.

Name Description
change

Fires when a change within the widget's input element is committed by an end user.

closed

Fires after a drop-down list has been hidden.

contentReady

Fires when widget content is ready.

copy

Fires after the widget's input has been copied.

customItemCreating

Fires when a user adds a custom item.

cut

Fires after the Cut DOM event has fired.

disposing

Fires when the widget is being removed.

enterKey

Fires after the Enter key has been pressed within the widget's input element.

focusIn

Fires after the widget's input has been focused.

focusOut

Fires after the widget's input element has lost focus.

initialized

Fires when the widget is initialized.

input

Fires when a value within the widget's input element is changed by an end user.

itemClick

Fires when a widget item is clicked.

keyDown

Fires when a key is pressed down within the widget's input element.

keyPress

Fires when the keypress DOM event has been raised for the current input element.

keyUp

Fires when a key is released within the widget's input element.

opened

Fires when the drop-down editor is shown.

optionChanged

Fires after an option of the component is changed.

paste

Fires after the widget's input has been pasted.

selectAllValueChanged

Fires when the select all check box value changes.

selectionChanged

Fires when the selection changes.

valueChanged

Fires when the editor value changes.

Default Item Template

This section lists the data source fields that are used in a default item template.

By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is the list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.

See Also