React TagBox API

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

import TagBox from "devextreme-react/tag-box"
Selector: TagBox

View Demo Start Tutorial

See Also
jQuery
Angular
Vue
React
jQuery
Angular
Vue
React

Configuration

An object defining configuration properties for the TagBox UI component.

Name Description
acceptCustomValue

Specifies whether the UI component allows a user to enter a custom value. Requires the onCustomItemCreating handler implementation.
accessKey

Specifies the shortcut key that sets focus on the UI component.
activeStateEnabled

Specifies whether the UI component changes its visual state as a result of user interaction.
applyValueMode

Specifies how the UI component applies values.
buttons

Allows you to add custom buttons to the input text field.
customItemCreateEvent

Specifies the DOM event after which the custom item should be created. Applies only if acceptCustomValue is enabled.
dataSource

Binds the UI component to data.
deferRendering

Specifies whether to render the drop-down field's content when it is displayed. If false, the content is rendered immediately.
disabled

Specifies whether the UI component responds to user interaction.
displayExpr

Specifies the data field whose values should be displayed.
dropDownButtonComponent

An alias for the dropDownButtonTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
dropDownButtonRender

An alias for the dropDownButtonTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
dropDownButtonTemplate

Specifies a custom template for the drop-down button.
dropDownOptions

Configures the drop-down field which holds the content.
elementAttr

Specifies the global attributes to be attached to the UI component's container element.
fieldComponent

An alias for the fieldTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
fieldRender

An alias for the fieldTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
fieldTemplate

Specifies a custom template for the text field. Must contain the TextBox UI component.
focusStateEnabled

Specifies whether the UI component can be focused using keyboard navigation.
groupComponent

An alias for the groupTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
grouped

Specifies whether data items should be grouped.
groupRender

An alias for the groupTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
groupTemplate

Specifies a custom template for group captions.
height

Specifies the UI component's height.
hideSelectedItems

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

Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.
inputAttr

Specifies the attributes to be passed on to the underlying HTML element.
isValid

Specifies or indicates whether the editor's value is valid.
itemComponent

An alias for the itemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
itemRender

An alias for the itemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
items

An array of items displayed by the UI component.
itemTemplate

Specifies a custom template for items.
label

Specifies a text string used to annotate the editor's value.
labelMode

Specifies the label's display mode.
maxDisplayedTags

Specifies the limit on displayed tags. On exceeding it, the UI component replaces all tags with a single multi-tag that displays the number of selected items.
maxFilterQueryLength

Specifies the maximum filter query length in characters.
maxLength

Specifies the maximum number of characters you can enter into the textbox.
minSearchLength

The minimum number of characters that must be entered into the text box to begin a search. Applies only if searchEnabled is true.
multiline

A Boolean value specifying whether or not the UI component is multiline.
name

The value to be assigned to the name attribute of the underlying HTML element.
noDataText

Specifies the text or HTML markup displayed by the UI component if the item collection is empty.
onChange

A function that is executed when the UI component loses focus after the text field's content was changed using the keyboard.
onClosed

A function that is executed once the drop-down editor is closed.
onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.
onCustomItemCreating

A function that is executed when a user adds a custom item. Requires acceptCustomValue to be set to true.
onDisposing

A function that is executed before the UI component is disposed of.
onEnterKey

A function that is executed when the Enter key has been pressed while the UI component is focused.
onFocusIn

A function that is executed when the UI component gets focus.
onFocusOut

A function that is executed when the UI component loses focus.
onInitialized

A function used in JavaScript frameworks to save the UI component instance.
onInput

A function that is executed each time the UI component's input is changed while the UI component is focused.
onItemClick

A function that is executed when a list item is clicked or tapped.
onKeyDown

A function that is executed when a user is pressing a key on the keyboard.
onKeyUp

A function that is executed when a user releases a key on the keyboard.
onMultiTagPreparing

A function that is executed before the multi-tag is rendered.
onOpened

A function that is executed once the drop-down editor is opened.
onOptionChanged

A function that is executed after a UI component property is changed.
onSelectAllValueChanged

A function that is executed when the "Select All" check box value is changed. Applies only if showSelectionControls is true.
onSelectionChanged

A function that is executed when a list item is selected or selection is canceled.
onValueChanged

A function that is executed after the UI component's value is changed.
opened

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

Specifies whether a user can open the drop-down list by clicking a text field.
placeholder

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

Specifies whether the editor is read-only.
rtlEnabled

Switches the UI component to a right-to-left representation.
searchEnabled

Specifies whether to allow search operations.
searchExpr

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

Specifies a comparison operation used to search UI component items.
searchTimeout

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

Specifies the mode in which all items are selected.
selectAllText

Specifies the text displayed at the "Select All" check box.
selectedItems

Gets the currently selected items.
showClearButton

Specifies whether to display the Clear button in the UI component.
showDataBeforeSearch

Specifies whether or not the UI component displays unfiltered values until a user types a number of characters exceeding the minSearchLength property value.
showDropDownButton

Specifies whether the drop-down button is visible.
showMultiTagOnly

Specifies whether the multi-tag is shown without ordinary tags.
showSelectionControls

Specifies whether or not to display selection controls.
stylingMode

Specifies how the UI component's text field is styled.
tabIndex

Specifies the number of the element when the Tab key is used for navigating.
tagComponent

An alias for the tagTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
tagRender

An alias for the tagTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
tagTemplate

Specifies a custom template for tags.
text

The read-only property that holds the text displayed by the UI component input element.
useItemTextAsTitle

Specifies whether the TagBox uses item's text a title attribute.
validationError

Information on the broken validation rule. Contains the first item from the validationErrors array.
validationErrors

An array of the validation rules that failed.
validationMessageMode

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

Specifies the position of a validation message relative to the component. The validation message describes the validation rules that this component's value does not satisfy.
validationStatus

Indicates or specifies the current validation status.
value

Specifies the selected items.
valueExpr

Specifies which data field provides unique values to the UI component's value.
visible

Specifies whether the UI component is visible.
width

Specifies the UI component's width.
wrapItemText

Specifies whether text that exceeds the drop-down list width should be wrapped.

See Also
jQuery
Angular
Vue
React

Methods

This section describes members used to manipulate data.

Name Description
beginUpdate()

Postpones rendering that can negatively affect performance until the endUpdate() method is called.
blur()

Removes focus from the input element.
close()

Closes the drop-down editor.
content()

Gets the popup window's content.
defaultOptions(rule)

Specifies the device-dependent default configuration properties for this component.
dispose()

Disposes of all the resources allocated to the TagBox instance.
element()

Gets the root UI component element.
endUpdate()

Refreshes the UI component after a call of the beginUpdate() method.
field()

Gets the UI component's <input> element.
focus()

Sets focus to the input element representing the UI component.
getButton(name)

Gets an instance of a custom action button.
getDataSource()

Gets the DataSource instance.
getInstance(element)

Gets the instance of a UI component found using its DOM node.
instance()

Gets the UI component's instance. Use it to access other methods of the UI component.
off(eventName)

Detaches all event handlers from a single event.
off(eventName, eventHandler)

Detaches a particular event handler from a single event.
on(eventName, eventHandler)

Subscribes to an event.
on(events)

Subscribes to events.
open()

Opens the drop-down editor.
option()

Gets all UI component properties.
option(optionName)

Gets the value of a single property.
option(optionName, optionValue)

Updates the value of a single property.
option(options)

Updates the values of several properties.
registerKeyHandler(key, handler)

Registers a handler to be executed when a user presses a specific key.
repaint()

Repaints the UI component without reloading data. Call it to update the UI component's markup.
reset()

Resets the value property to the default value.
resetOption(optionName)

Resets a property to its default value.

Events

This section describes events fired by this UI component.

Name Description
change

Raised when the UI component loses focus after the text field's content was changed using the keyboard.
closed

Raised once the drop-down editor is closed.
contentReady

Raised when the UI component's content is ready.
customItemCreating

Raised when a user adds a custom item.
disposing

Raised before the UI component is disposed of.
enterKey

Raised when the Enter key has been pressed while the UI component is focused.
focusIn

Raised when the UI component gets focus.
focusOut

Raised when the UI component loses focus.
initialized

Raised only once, after the UI component is initialized.
input

Raised each time the UI component's input is changed while the UI component is focused.
itemClick

Raised when a list item is clicked or tapped.
keyDown

Raised when a user is pressing a key on the keyboard.
keyUp

Raised when a user releases a key on the keyboard.
multiTagPreparing

Raised before the multi-tag is rendered.
opened

Raised once the drop-down editor is opened.
optionChanged

Raised after a UI component property is changed.
selectAllValueChanged

Raised when the "Select All" check box value is changed.
selectionChanged

Raised when a list item is selected or selection is canceled.
valueChanged

Raised after the UI component's value is changed.

See Also
jQuery
Angular
Vue
React