JavaScript/jQuery TagBox Options

See Also

View Demo

See Also

• Create a User-Defined Item

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

The UI component switches to the active state when users press down the primary mouse button. When this property is set to true, the CSS rules for the active state apply. You can change these rules to customize the component.

Use this property when you display the component on a platform whose guidelines include the active state change for UI components.

The property accepts the following values.

• instantly
  Applies values when they are selected.

• useButtons
  Applies values when a user clicks the "OK" button.

Built-in buttons should also be declared in this array. You can find an example in the following demo:

View Demo

This property accepts a single event name or several names separated by spaces.

The recommended events are "blur", "change", and "focusout", but you can use other events as well. The default value of this property is "change", and items are created when the component loses focus.

If you want to enable custom item creation when users press the Tab key, assign "change" or "focusout" to this property.

The TagBox works with collections of objects or string, number, or boolean values.

Depending on your data source, bind TagBox to data as follows. In each case, also specify the valueExpr, displayExpr, or both if the data source provides objects.

• Data Array
  Assign the array to the dataSource option.

• Read-Only Data in JSON Format
  Set the dataSource property to the URL of a JSON file or service that returns JSON data.

• OData
  Implement an ODataStore.

• Web API, PHP, MongoDB
  Use one of the following extensions to enable the server to process data according to the protocol DevExtreme UI components use:

  • DevExtreme.AspNet.Data
  • DevExtreme-PHP-Data
  • devextreme-query-mongodb

  Then, use the createStore method to configure access to the server on the client as shown below. This method is part of DevExtreme.AspNet.Data.

  jQuery

  JavaScript

  $(function() {
      let serviceUrl = "https://url/to/my/service";
      $("#tagBoxContainer").dxTagBox({
          // ...
          dataSource: DevExpress.data.AspNet.createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      })
  });

  Angular

  app.component.ts

  app.component.html

  app.module.ts

  import { Component } from '@angular/core';
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      store: CustomStore;
      constructor() {
          let serviceUrl = "https://url/to/my/service";
          this.store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          })
      }
  }

  <dx-tag-box ...
      [dataSource]="store">
  </dx-tag-box>

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxTagBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxTagBoxModule
      ],
      providers: [],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template> 
      <DxTagBox ...
          :data-source="store" />
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import { DxTagBox } from 'devextreme-vue/tag-box';
  
  export default {
      components: {
          DxTagBox
      },
      data() {
          const serviceUrl = "https://url/to/my/service";
          const store = createStore({
              key: "ID",
              loadUrl: serviceUrl + "/GetAction",
              insertUrl: serviceUrl + "/InsertAction",
              updateUrl: serviceUrl + "/UpdateAction",
              deleteUrl: serviceUrl + "/DeleteAction"
          });
          return {
              store
          }
      }
  }
  </script>

  React

  App.js

  import React from 'react';
  import 'devextreme/dist/css/dx.light.css';
  
  import CustomStore from 'devextreme/data/custom_store';
  import { createStore } from 'devextreme-aspnet-data-nojquery';
  import TagBox from 'devextreme-react/tag-box';
  
  const serviceUrl = "https://url/to/my/service";
  const store = createStore({
      key: "ID",
      loadUrl: serviceUrl + "/GetAction",
      insertUrl: serviceUrl + "/InsertAction",
      updateUrl: serviceUrl + "/UpdateAction",
      deleteUrl: serviceUrl + "/DeleteAction"
  });
  
  class App extends React.Component {
      render() {
          return (
              <TagBox ...
                  dataSource={store} />
          );
      }
  }
  export default App;

• Any other data source
  Implement a CustomStore.

Regardless of the data source on the input, the TagBox always wraps it in the DataSource object. This object allows you to sort, filter, group, and perform other data shaping operations. To get its instance, call the getDataSource() method.

View Demo

View Demo

View Demo

Set this property to the name of a data field that provides displayed values...

displayExpr: "name"

... or to a function that returns the displayed value:

displayExpr: function(item) {
    // "item" can be null
    return item && 'ID: ' + item.id + ', Name: ' + item.name;
}

Leave this property unspecified or set it to this if the data source contains primitives.

See Also

• valueExpr

View Demo

See Also

• Custom Templates

See Popup Configuration for properties that you can specify in this object.

If you define a fieldTemplate, the component does not render the underlying HTML. In this case, you should render hidden input with the corresponding name attribute to submit values through a HTML form.

The example below shows how to define the fieldTemplate. If you want to customize the field's text, use the TextBox's value property.

$(function() {
    $("#tagBox").dxTagBox({
        // ...
        fieldTemplate(data, container) {
            container.append(
                $('<div>').dxTextBox({
                    value: data.Category + ": " + data.Name,
                    readOnly: true
                })
            )
        },
    });
});

<dx-tag-box ...
    fieldTemplate="field"
>
    <div *dxTemplate="let data of 'field'">
        <div>
            <dx-text-box 
                [value]="data && data.Category + ': ' + data.Name" 
                [readOnly]="true"
            >
            </dx-text-box>
        </div>
    </div>
</dx-tag-box>

<template>
    <DxTagBox ...
        field-template="field"
    >
        <template #field="{ data }">
            <DxTextBox 
                :value="data && data.Category + ': ' + data.Name" 
                :read-only="true"
            />
        </template>
    </DxTagBox>
</template>

<script>
// ...
import DxTagBox from 'devextreme-vue/tag-box';
import DxTextBox from 'devextreme-vue/text-box';

export default {
    components: {
        DxTagBox,
        DxTextBox
    },
    data() {
        return {
            // ...
        }
    }
}
</script>

import React from "react";
import TagBox from "devextreme-react/tag-box";
import TextBox from "devextreme-react/text-box";

function Field(data) {
    return <TextBox value={data && data.Category + ': ' + data.Name} readOnly={true} />;
}
function App() {
    return (
        <TagBox ...
            fieldRender={Field}
        />
        </div>
    );
}

export default App;

View Demo

See Also

• Customize Item Appearance
• Custom Templates

When this property is true, make sure that all data source objects have the following structure:

const dataSource = [{
    key: "Group 1", // Group caption 
    items: [ // Items in the group
        { ... },
        { ... }
    ]
}, {
    // ...
}];

You can supply data to this structure using the DataSource object's group property.

SelectBox Demo TagBox Demo

See Also

• SelectBox - Grouping
• TagBox - Grouping

View Demo

See Also

• Customize Group Headers
• Custom Templates

This property accepts a value of one of the following types:

• Number
  The height in pixels.

• String
  A CSS-accepted measurement of height. For example, "55px", "20vh", "80%", "inherit".

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.

$(function(){
    $("#tagBoxContainer").dxTagBox({
        // ...
        inputAttr: {
            id: "inputId"
        }
    });
});

<dx-tag-box ...
    [inputAttr]="{ id: 'inputId' }">
</dx-tag-box>

import { DxTagBoxModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxTagBoxModule
    ],
    // ...
})

<template>
    <DxTagBox
        :input-attr="inputAttr"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxTagBox from 'devextreme-vue/tag-box';

export default {
    components: {
        DxTagBox
    },
    data() {
        return {
            inputAttr: { id: 'inputId' }
        }
    }
}
</script>

import 'devextreme/dist/css/dx.light.css';

import TagBox from 'devextreme-react/tag-box';

const inputAttr = { id: 'inputId' };

export default function App() {
    return (
        <TagBox
            inputAttr={inputAttr}
        />
    );
}

@(Html.DevExtreme().TagBox()
    .InputAttr("id", "inputId")
    // ===== or =====
    .InputAttr(new {
        @id = "inputId"
    })
    // ===== or =====
    .InputAttr(new Dictionary<string, object>() {
        { "id", "inputId" }
    })
)

@(Html.DevExtreme().TagBox() _
    .InputAttr("id", "inputId")
    ' ===== or =====
    .InputAttr(New With {
        .id = "inputId"
    })
    ' ===== or =====
    .InputAttr(New Dictionary(Of String, Object) From {
        { "id", "inputId" }
    })
)

To improve accessibility, use this property to specify aria-label for the component.

$(function(){
    $("#tagBoxContainer").dxTagBox({
        // ...
        inputAttr: {
            'aria-label': 'your-label',
        },
    });
});

<dx-tag-box ...
    [inputAttr]="{ 'aria-label': 'your-label' }">
</dx-tag-box>

<template>
    <DxTagBox
        :input-attr="inputAttr"
    />
</template>

<script>
import DxTagBox from 'devextreme-vue/tag-box';

export default {
    components: {
        DxTagBox
    },
    data() {
        return {
            inputAttr: { 'aria-label': 'your-label' }
        }
    }
}
</script>

import TagBox from 'devextreme-react/tag-box';

const inputAttr = { 'aria-label': 'your-label' };

export default function App() {
    return (
        <TagBox
            inputAttr={inputAttr}
        />
    );
}

You do not need to specify aria-label if you use label.

This property is a read-only flag. You can use it to check if the editor value changed.

$(() => {
    const tagBox = $('#tagBox').dxTagBox({
        // ...
    }).dxTagBox('instance');

    $('#button').dxButton({
        // ...
        onClick () {
            if (tagBox.option('isDirty')) {
                DevExpress.ui.notify("Do not forget to save changes", "warning", 500);
            }
        }
    });
});

import { Component, ViewChild } from '@angular/core';
import { DxTagBoxComponent, DxButtonModule } from 'devextreme-angular';
import notify from 'devextreme/ui/notify';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    @ViewChild('tagBoxRef', { static: false }) tagBox: DxTagBoxComponent;

    onClick () {
        if (this.tagBox.instance.option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    }
}

<dx-tag-box ... 
    #tagBoxRef
>
</dx-tag-box>
<dx-button ...
    (onClick)="onClick($event)"
>
</dx-button>

<template>
    <DxTagBox ...
        :ref="tagBoxRef"
    >
    </DxTagBox>
    <DxButton ...
        @click="onClick"
    />
</template>

<script>
import 'devextreme/dist/css/dx.light.css';
import DxTagBox from 'devextreme-vue/tag-box';
import DxButton from 'devextreme-vue/button';
import notify from 'devextreme/ui/notify';

export default {
    components: {
        DxTagBox,
        DxButton
    },

    data() {
        return {
            tagBoxRef
        }
    },

    methods: {
        onClick () {
            if (this.tagBox.option('isDirty')) {
                notify("Do not forget to save changes", "warning", 500);
            }
        }
    },

    computed: {
        tagBox: function() {
            return this.$refs[tagBoxRef].instance;
        }
    }
}
</script>

import React, { useRef } from 'react';
import TagBox from 'devextreme-react/tag-box';
import Button from 'devextreme-react/button';
import 'devextreme/dist/css/dx.light.css';

const App = () => {
    const tagBoxRef = useRef(null);

    const onClick = () => {
        if (this.tagBoxRef.current.instance().option('isDirty')) {
            notify("Do not forget to save changes", "warning", 500);
        }
    };

    return (
        <TagBox ...
            ref={tagBoxRef}
        >
        </TagBox>
        <Button ...
            onClick={onClick}
        />
    );
};

export default App;

See Also

• reset

See Also

• validationErrors

The items array can contain:

• Objects with fields described in this section
• Objects with any other fields. In this case, specify the itemTemplate.

If you need to update the UI component items, reassign the entire items array as shown in the following example:

tagBoxInstance.option('items', newItems);

As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.

View Demo

View Demo

See Also

• Customize Item Appearance
• Custom Templates

See Also

• labelMode
• placeholder

This property can have one of the following values:

View Demo

See Also

• showMultiTagOnly
• onMultiTagPreparing

If the number of entered characters reaches the value assigned to this property, the UI component does not allow you to enter any more characters.

View Demo

See Also

• showDataBeforeSearch

Specify this property if the UI component lies within an HTML form that will be submitted.

The TagBox component evaluates the noDataText property's value. This evaluation, however, makes the TagBox potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the noDataText property. Refer to the following help topic for more information: Potentially Vulnerable API - noDataText.

View Demo

You can specify DOM events after which the component calls this function. Use the customItemCreateEvent property for this purpose. Besides the event passed to this property, the item can also be created when users press the Enter key.

The following code shows how to enable item creation when the Space key is pressed:

$(function() {
    $("#tagBox").dxTagBox({
        // ...
        items: [{ id: 1, text: 'item 1'}],
        acceptCustomValue: true,
        displayExpr: 'text',
        onCustomItemCreating: (args) => {
            if (!args.text) {
                args.customItem = null;
                return;
            }

            const { component, text } = args;
            const currentItems = component.option('items');

            const newId = currentItems.at(-1).id + 1;
            const newItem = {
                id: newId,
                text: text.trim(),
            };

            const itemInDataSource = currentItems.find((item) => item.text === newItem.text)
            if (itemInDataSource) {
                args.customItem = itemInDataSource;
            } else {    
                currentItems.push(newItem);
                component.option('items', currentItems);
                args.customItem = newItem;
            }
        },
        onKeyDown: (e) => {
            if (e.event.code === 'Space') {
                const event = new KeyboardEvent('keydown', {
                    key: 'Enter',
                    keyCode: 13,
                    which: 13,
                });
                const target = e.event.target;
                target.dispatchEvent(event);
            }
        }
    });
});

<dx-tag-box ...
    [items]="itemsArray"
    displayExpr="text"
    [acceptCustomValue]="true"
    (onCustomItemCreating)="onCustomItemCreating($event)"
    (onKeyDown)="onKeyDown($event)"
>
</dx-tag-box>

// ...
export class AppComponent {
    itemsArray = [{ id: 1, text: 'item 1'}];

    onCustomItemCreating(args) {
        if (!args.text) {
            args.customItem = null;
            return;
        }

        const { component, text } = args;
        const currentItems = component.option('items');

        const newId = currentItems.at(-1).id + 1;
        const newItem = {
            id: newId,
            text: text.trim(),
        };

        const itemInDataSource = currentItems.find((item) => item.text === newItem.text)
        if (itemInDataSource) {
            args.customItem = itemInDataSource;
        } else {    
            currentItems.push(newItem);
            component.option('items', currentItems);
            args.customItem = newItem;
        }
    }
    onKeyDown(e) {
        if (e.event.code === 'Space') {
            const event = new KeyboardEvent('keydown', {
                key: 'Enter',
                keyCode: 13,
                which: 13,
            });
            const target = e.event.target;
            target.dispatchEvent(event);
        }
    }
}

<template>
    <DxTagBox ...
        :items="itemsArray"
        display-expr="text"
        :accept-custom-value="true"
        @customItemCreating="onCustomItemCreating"
        @keyDown="onKeyDown"
    >
    </DxTagBox>
</template>

<script>
// ...
export default {
    components: {
        DxTagBox
    },
    data() {
        return {
            itemsArray: [{ id: 1, text: 'item 1'}]
        }
    },
    methods: {
        onCustomItemCreating(args) {
            if (!args.text) {
                args.customItem = null;
                return;
            }

            const { component, text } = args;
            const currentItems = component.option('items');

            const newId = currentItems.at(-1).id + 1;
            const newItem = {
                id: newId,
                text: text.trim(),
            };

            const itemInDataSource = currentItems.find((item) => item.text === newItem.text)
            if (itemInDataSource) {
                args.customItem = itemInDataSource;
            } else {    
                currentItems.push(newItem);
                component.option('items', currentItems);
                args.customItem = newItem;
            }
        },
        onKeyDown(e) {
            if (e.event.code === 'Space') {
                const event = new KeyboardEvent('keydown', {
                    key: 'Enter',
                    keyCode: 13,
                    which: 13,
                });
                const target = e.event.target;
                target.dispatchEvent(event);
            }
        }
    }
}
</script>

// ...
const itemsArray = [{ id: 1, text: 'item 1'}];

const onCustomItemCreating = (args) => {
    if (!args.text) {
        args.customItem = null;
        return;
    }

    const { component, text } = args;
    const currentItems = component.option('items');

    const newId = currentItems.at(-1).id + 1;
    const newItem = {
        id: newId,
        text: text.trim(),
    };

    const itemInDataSource = currentItems.find((item) => item.text === newItem.text)
    if (itemInDataSource) {
        args.customItem = itemInDataSource;
    } else {    
        currentItems.push(newItem);
        component.option('items', currentItems);
        args.customItem = newItem;
    }
}

const onKeyDown = (e) => {
    if (e.event.code === 'Space') {
        const event = new KeyboardEvent('keydown', {
            key: 'Enter',
            keyCode: 13,
            which: 13,
        });
        const target = e.event.target;
        target.dispatchEvent(event);
    }
}

function App() {
    return (
        <TagBox ...
            items={itemsArray}
            displayExpr="text"
            acceptCustomValue={true}
            onCustomItemCreating={onCustomItemCreating}
            onKeyDown={onKeyDown}
        />
    );
}

export default App;

See Also

• Create a User-Defined Item

<dx-tag-box ...
    (onInitialized)="saveInstance($event)">
</dx-tag-box>

import { Component } from "@angular/core";
import TagBox from "devextreme/ui/data_grid";
// ...
export class AppComponent {
    tagBoxInstance: TagBox;
    saveInstance (e) {
        this.tagBoxInstance = e.component;
    }
}

<template>
    <div>
        <DxTagBox ...
            @initialized="saveInstance">
        </DxTagBox>
    </div>
</template>

<script>
import DxTagBox from 'devextreme-vue/tag-box';

export default {
    components: {
        DxTagBox
    },
    data: function() {
        return {
            tagBoxInstance: null
        };
    },
    methods: {
        saveInstance: function(e) {
            this.tagBoxInstance = e.component;
        }
    }
};
</script>

<template>
    <div>
        <DxTagBox ...
            @initialized="saveInstance">
        </DxTagBox>
    </div>
</template>

<script setup>
import DxTagBox from 'devextreme-vue/tag-box';

let tagBoxInstance = null;

const saveInstance = (e) => {
    tagBoxInstance = e.component;
}
</script>

import TagBox from 'devextreme-react/tag-box';

class App extends React.Component {
    constructor(props) {
        super(props);

        this.saveInstance = this.saveInstance.bind(this);
    }

    saveInstance(e) {
        this.tagBoxInstance = e.component;
    }

    render() {
        return (
            <div>
                <TagBox onInitialized={this.saveInstance} />
            </div>
        );
    }
}

See Also

View Demo

See Also

• Limit the Tag Count
• maxDisplayedTags
• showMultiTagOnly

The following example shows how to subscribe to component property changes:

$(function() {
    $("#tagBoxContainer").dxTagBox({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

<dx-tag-box ...
    (onOptionChanged)="handlePropertyChange($event)"> 
</dx-tag-box>

import { Component } from '@angular/core'; 

@Component({ 
    selector: 'app-root', 
    templateUrl: './app.component.html', 
    styleUrls: ['./app.component.css'] 
}) 

export class AppComponent { 
    // ...
    handlePropertyChange(e) {
        if(e.name === "changedProperty") { 
            // handle the property change here
        }
    }
}

import { BrowserModule } from '@angular/platform-browser'; 
import { NgModule } from '@angular/core'; 
import { AppComponent } from './app.component'; 
import { DxTagBoxModule } from 'devextreme-angular'; 

@NgModule({ 
    declarations: [ 
        AppComponent 
    ], 
    imports: [ 
        BrowserModule, 
        DxTagBoxModule 
    ], 
    providers: [ ], 
    bootstrap: [AppComponent] 
}) 

export class AppModule { }  

<template> 
    <DxTagBox ...
        @option-changed="handlePropertyChange"
    />            
</template> 

<script>  
import 'devextreme/dist/css/dx.light.css'; 
import DxTagBox from 'devextreme-vue/tag-box'; 

export default { 
    components: { 
        DxTagBox
    }, 
    // ...
    methods: { 
        handlePropertyChange: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    } 
} 
</script> 

import React from 'react';  
import 'devextreme/dist/css/dx.light.css'; 

import TagBox from 'devextreme-react/tag-box'; 

const handlePropertyChange = (e) => {
    if(e.name === "changedProperty") {
        // handle the property change here
    }
}

export default function App() { 
    return ( 
        <TagBox ...
            onOptionChanged={handlePropertyChange}
        />        
    ); 
} 

View on GitHub

See Also

• valueChangeEvent

See Also

• showDropDownButton

View Demo

When this property is set to true, the following applies:

• The editor's value cannot be changed using the UI.
• Built-in action buttons are invisible.

• Custom action buttons are visible but disabled. If a button should not be disabled, set its disabled property to false:

  jQuery

  index.js

  $(function() {
      $("#tagBoxContainer").dxTagBox({
          // ...
          buttons: [{
              name: "myCustomButton",
              location: "after",
              options: {
                  onClick: function(e) {
                      // ...
                  },
                  disabled: false
              }
          }]
      });
  });

  Angular

  app.component.html

  app.component.ts

  app.module.ts

  <dx-tag-box ... >
      <dxi-button
          name="myCustomButton"
          location="after"
          [options]="myCustomButtonConfig">
      </dxi-button>
  </dx-tag-box>

  import { Component } from '@angular/core';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      myCustomButtonConfig = {
          onClick: (e) => {
              // ...
          },
          disabled: false
      };
  }

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxTagBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxTagBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template>
      <DxTagBox ... >
          <DxTagBoxButton
              name="myCustomButton"
              location="after"
              :options="myCustomButtonConfig"
          />
      </DxTagBox>
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import DxTagBox, {
      DxButton as DxTagBoxButton
  } from 'devextreme-vue/tag-box';
  
  export default {
      components: {
          DxTagBox,
          DxTagBoxButton
      },
      data() {
          return {
              myCustomButtonConfig: {
                  onClick: (e) => {
                      // ...
                  },
                  disabled: false
              }
          }
      }
  }
  </script>

  React

  App.js

  import React from 'react';
  
  import 'devextreme/dist/css/dx.light.css';
  
  import TagBox, {
      Button as TagBoxButton
  } from 'devextreme-react/tag-box';
  
  class App extends React.Component {
      myCustomButtonConfig = {
          onClick: (e) => {
              // ...
          },
          disabled: false
      };
      render() {
          return (
              <TagBox>
                  <TagBoxButton
                      name="myCustomButton"
                      location="after"
                      options={this.myCustomButtonConfig}
                  />
              </TagBox>
          );
      }
  }
  export default App;

  You can also hide a custom action button when the UI component becomes read-only. Set the button's visible property to false in the onOptionChanged function. To get the button, use the getButton(name) method:

  jQuery

  index.js

  $(function() {
      $("#tagBoxContainer").dxTagBox({
          // ...
          buttons: [{
              name: "myCustomButton",
              // ...
          }],
          onOptionChanged: function(e) {
              if(e.name == "readOnly") {
                  const myButton = e.component.getButton("myCustomButton");
                  myButton.option("visible", !e.value); // Hide the button when readOnly: true
              }
          }
      });
  });

  Angular

  app.component.html

  app.component.ts

  app.module.ts

  <dx-tag-box ...
      (onOptionChanged)="changeButtonState">
      <dxi-button
          name="myCustomButton"
          ...
      ></dxi-button>
  </dx-tag-box>

  import { Component } from '@angular/core';
  
  @Component({
      selector: 'app-root',
      templateUrl: './app.component.html',
      styleUrls: ['./app.component.css']
  })
  export class AppComponent {
      changeButtonState(e) {
          if(e.name == 'readOnly') {
              let myButton = e.component.getButton('myCustomButton');
              myButton.option('visible', !e.value); // Hide the button when readOnly: true
          }
      }
  }

  import { BrowserModule } from '@angular/platform-browser';
  import { NgModule } from '@angular/core';
  import { AppComponent } from './app.component';
  
  import { DxTagBoxModule } from 'devextreme-angular';
  
  @NgModule({
      declarations: [
          AppComponent
      ],
      imports: [
          BrowserModule,
          DxTagBoxModule
      ],
      providers: [ ],
      bootstrap: [AppComponent]
  })
  export class AppModule { }

  Vue

  App.vue

  <template>
      <DxTagBox ...
          @option-changed="changeButtonState">
          <DxTagBoxButton
              name="myCustomButton"
              ...
          />
      </DxTagBox>
  </template>
  
  <script>
  import 'devextreme/dist/css/dx.light.css';
  
  import DxTagBox, {
      DxButton as DxTagBoxButton
  } from 'devextreme-vue/tag-box';
  
  export default {
      components: {
          DxTagBox,
          DxTagBoxButton
      },
      data() {
          return {
              // ...
          }
      },
      methods: {
          changeButtonState(e) {
              if(e.name == 'readOnly') {
                  let myButton = e.component.getButton('myCustomButton');
                  myButton.option('visible', !e.value); // Hide the button when readOnly: true
              }
          }
      }
  }
  </script>

  React

  App.js

  import React from 'react';
  
  import 'devextreme/dist/css/dx.light.css';
  
  import TagBox, {
      Button as TagBoxButton
  } from 'devextreme-react/tag-box';
  
  class App extends React.Component {
      changeButtonState(e) {
          if(e.name == 'readOnly') {
              let myButton = e.component.getButton('myCustomButton');
              myButton.option('visible', !e.value); // Hide the button when readOnly: true
          }
      }
      render() {
          return (
              <TagBox ...
                  onOptionChanged={this.changeButtonState}>
                  <TagBoxButton
                      name="myCustomButton"
                      ...
                  />
              </TagBox>
          );
      }
  }
  export default App;

View Demo

When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.

DevExpress.config({
    rtlEnabled: true
});

DataGrid Demo Navigation UI Demo Editors Demo

View Demo

See Also

• Configure Search Parameters

In most cases, you should pass the name of a field by whose value data items are searched. If you need to search elements by several field values, assign an array of field names to this property.

searchExpr: ["firstName", "lastName"]

For more information on searching, refer to the Search API section of the Data Layer article. For information on getters, refer to the Getters and Setters section of the Data Layer article.

View Demo

View Demo

View Demo

The selectAllMode specifies how records should be selected on clicking the "Select All" check box. The following modes are available.

• 'page'
  Selects items on the currently rendered pages.

• 'allPages'
  Selects items on all pages.

The Clear button calls the reset method.

If this property is disabled, the UI component does not display values until the number of typed characters exceeds the minSearchLength value, otherwise it displays all values regardless of the specified filtering condition.

View Demo

See Also

• dropDownButtonTemplate

View Demo

See Also

• onMultiTagPreparing

The following styles are available:

You can also use the global editorStylingMode setting to specify how the text fields of all editors in your application are styled.

The value of this property will be passed to the tabindex attribute of the HTML element that underlies the UI component.

This template replaces the default tag template. If you need to recreate the default tag appearance and specific template elements (such as the closing button) in your custom template, do so as follows:

$(function() {
    $("#tagBoxContainer").dxTagBox({
        // ...
        tagTemplate: function(tagData) {
            return $("<div />")
                .addClass("dx-tag-content")
                .append(
                    $("<span />").text("TAG CONTENT"),
                    $("<div />").addClass("dx-tag-remove-button")
                );
        }
    });
});

<dx-tag-box ...
    tagTemplate="tagTemplate">
    <div *dxTemplate="let tagData of 'tagTemplate'" class="dx-tag-content">
        TAG CONTENT
        <div class="dx-tag-remove-button"></div>
    </div>
</dx-tag-box>

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';
import { AppComponent } from './app.component';

import { DxTagBoxModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxTagBoxModule
    ],
    providers: [],
    bootstrap: [AppComponent]
})
export class AppModule { }

<template>
    <DxTagBox ...
        tag-template="tagTemplate">
        <div slot="tagTemplate" slot-scope="{ tagData }" class="dx-tag-content">
            TAG CONTENT
            <div class="dx-tag-remove-button"></div>
        </div>
    </DxTagBox>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxTagBox from 'devextreme-vue/tag-box';

export default {
    components: {
        DxTagBox
    },
    // ...
}
</script>

import React from 'react';

import 'devextreme/dist/css/dx.light.css';

import TagBox from 'devextreme-react/tag-box';

const renderTag = (tagData) => {
    return (
        <div class="dx-tag-content">
            TAG CONTENT
            <div class="dx-tag-remove-button"></div>
        </div>
    );
}

class App extends React.Component {
    render() {
        return (
            <TagBox ...
                tagRender={renderTag}
            />
        );
    }
}
export default App;

See Also

• Customize Item Appearance
• Custom Templates

If the property is set to true, the text that items within the TagBox contain is passed to the title attribute of the respective item.

See Also

• isValid

The following property values are possible:

• auto
  The tooltip with the message is displayed when the editor is in focus.
• always
  The tooltip with the message is not hidden when the editor loses focus.

If you set this property to auto, the component specifies the validation message position automatically.

The following example positions a validation message at the component's right:

$(function() {
    $("#tagBoxContainer").dxTagBox({
        // ...
        validationMessagePosition: 'right'
    }).dxValidator({
        validationRules: [{
            type: 'required',
            message: 'Required',
        }],
    });
});

<dx-tag-box ...
    validationMessagePosition="right">
    <dx-validator>
        <dxi-validation-rule
            type="required"
            message="Required"
        >
        </dxi-validation-rule>
    </dx-validator>
</dx-tag-box>

<template>
    <DxTagBox ...
        validation-message-position="right"
    >
        <DxValidator>
            <DxRequiredRule message="Required" />
        </DxValidator>
    </DxTagBox>
</template>

<script>
    // ...
</script>

import React from 'react';
// ...

function App() {
    return (
        <TagBox ...
            validationMessagePosition="right"
        >
            <Validator>
                <RequiredRule message="Required" />
            </Validator>
        </TagBox>
    ); 

};
export default App;

The following table illustrates the validation status indicators:

validationStatus	Indicator
"pending"
"valid"
"invalid"

When you assign "invalid" to validationStatus, you can also use the validationErrors array to set an error message as shown below:

$(function() {
    const tagBox = $("#tagBoxContainer").dxTagBox({
        // ...
    }).dxTagBox("instance");

    function setInvalidStatus(message) {
        tagBox.option({
            validationStatus: "invalid",
            validationErrors: [{ message: message }]
        });
    }
});

<dx-tag-box
    [validationStatus]="validationStatus"
    [validationErrors]="validationErrors">
</dx-tag-box>

// ...
export class AppComponent {
    validationStatus: string = "valid";
    validationErrors: any;
    // ...
    setInvalidStatus(message) {
        this.validationStatus = "invalid";
        this.validationErrors = [{ message: message }];
    }
}

<template>
    <DxTagBox ...
        :validation-status="validationStatus"
        :validation-errors="validationErrors"
    />
</template>

<script>
    // ...
    export default {
        // ...
        data() {
            return {
                validationStatus: "valid",
                validationErrors: []
            }
        },
        methods: {
            setInvalidStatus(message) {
                this.validationStatus = "invalid";
                this.validationErrors = [{ message: message }];
            }
        }
    }
</script>

import React, { useState } from 'react';
// ...

function App() {
    const [validationStatus, setValidationStatus] = useState("valid");
    const [validationErrors, setValidationErrors] = useState([]);

    const setInvalidStatus = message => {
        setValidationStatus("invalid");
        setValidationErrors([{ message: message }]);
    }

    return (
        <TagBox
            validationStatus={validationStatus}
            validationErrors={validationErrors}
        />
    ); 

};
export default App;

Pass an array of items to this property to select them.

View Demo

View Demo

When dataSource contains objects, you should define valueExpr to correctly identify data items. Otherwise, the component uses referential equality to compare objects, which may result in unexpected behavior.

If you use a store, the valueExpr property should have the same value as the key in the store. Alternatively, you can use this as a valueExpr but the key should be specified. Refer to the following article for more information: Troubleshooting - A Drop-Down Editor Does Not Show Data.

Do not use template as a valueExpr value.

See Also

• displayExpr

This property accepts a value of one of the following types:

• Number
  The width in pixels.

• String
  A CSS-accepted measurement of width. For example, "55px", "20vw", "80%", "auto", "inherit".

• Function (deprecated since v21.2)
  Refer to the W0017 warning description for information on how you can migrate to viewport units.