JavaScript/jQuery Toolbar - items

The items array can contain:

• Strings
• 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:

toolbarInstance.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.

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

You can use the text property as a safe alternative.

Whatever template you use for UI component items (default or a custom) will be located according to the value specified for the location field in the item data source object.

See Also

• Toolbar - Specify Item Location

The following types of the specified value are available.

• Assign a string containing the name of the required template.
• Assign a jQuery object of the template's container.
• Assign a DOM Node of the template's container.
• Assign a function that returns the jQuery object or a DOM Node of the template's container.

See Also

• Custom Templates

options should contain the properties of the DevExtreme UI component specified in the widget property. Because of this dependency, options cannot be typed and are not implemented as nested configuration components in Angular, Vue, and React. In these frameworks, specify options with an object. We recommend that you declare the object outside the configuration component in Vue and React to prevent possible issues caused by unnecessary re-rendering.

<dx-toolbar ... >
    <dxi-item
        widget="dxCheckBox"
        [options]="{ text: 'Show IDs' }">
    </dxi-item>
</dx-toolbar>

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

import { DxToolbarModule } from 'devextreme-angular';

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

<template>
    <DxToolbar ... >
        <DxItem ...
            widget="dxCheckBox"
            :options="checkBoxOptions"
        />
    </DxToolbar>
</template>

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

import DxToolbar, {
    DxItem
} from 'devextreme-vue/toolbar';

export default {
    components: {
        DxToolbar,
        DxItem
    },
    data() {
        return {
            checkBoxOptions: { text: 'Show IDs' }
        }
    }
}
</script>

import React from 'react';

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

import Toolbar, {
    Item
} from 'devextreme-react/toolbar';

class App extends React.Component {
    checkBoxOptions = { text: 'Show IDs' };

    render() {
        return (
            <Toolbar ... >
                <Item
                    widget="dxCheckBox"
                    options={this.checkBoxOptions}
                />
            </Toolbar>
        );
    }
}
export default App;

See Also

• Toolbar - Specify Item Type

The text should be specified in the options configuration object.

The following types of the specified value are available.

• Assign a string containing the name of the required template.
• Assign a jQuery object of the template's container.
• Assign a DOM Node of the template's container.
• Assign a function that returns the jQuery object or a DOM Node of the template's container.

See Also

• Custom Templates

See Also

• Toolbar - Specify Item Type