Angular Toolbar - items

An array of items displayed by the UI component.

Selector: dxi-item
Type:

Array<String | dxToolbarItem | any>

Raised Events: onOptionChanged

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:

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

NOTE
Do not use the items property if you use dataSource, and vice versa.

cssClass

Specifies a CSS class to be applied to the item.

Type:

String

| undefined
Default Value: undefined

disabled

Specifies whether the UI component item responds to user interaction.

Type:

Boolean

Default Value: false

html

Specifies the HTML markup to be inserted into the item element.

Type:

String

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.

locateInMenu

Specifies when to display an item in the toolbar's overflow menu.

Type:

LocateInMenuMode

Default Value: 'never'

location

Specifies a location for the item on the toolbar.

Type:

ToolbarItemLocation

Default Value: 'center'

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

menuItemTemplate

Specifies a template that should be used to render a menu item.

Type:

template

Template Data: undefined

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.
jQuery
index.js
$(function() {
    $("#toolbar").dxToolbar({
        items: [{
            // ...
            menuItemTemplate (data, index) {
                return $(`<div><i class='dx-icon-favorites'></i>${data.options.text}</div>`);
            }
        }],
    });
});
Angular
app.component.html
<dx-toolbar>
    <dxi-item ... 
        menuItemTemplate="menu-item"
    >
    </dxi-item>
    <div *dxTemplate="let data of 'menu-item'">
        <i class="dx-icon-favorites"></i> {{data.options.text}}
    </div>
</dx-toolbar>
Vue
App.vue
<template>
    <DxToolbar>
        <dxItem ... 
            menu-item-template="menu-item"
        >
        </dxItem>
        <template #menu-item="{ data }">
            <i class="dx-icon-favorites"></i> {{data.options.text}}
        </template>
    </DxToolbar>
</template>

<script>
// ...
</script>
React
App.js
import React from 'react';
import Toolbar, { Item } from 'devextreme-react/toolbar';

const renderMenuItem = (data) => {
    return <div><i class="dx-icon-favorites"></i> {data.options.text}</div>;
}

function App() {
    return (
        <Toolbar>
            <Item ... 
                menuItemRender={renderMenuItem}
            >
            </Item>
        </Toolbar>
    );
}

export default App;
See Also

options

Configures the DevExtreme UI component used as a toolbar item.

Type: any

jQuery
$('#toolbar').dxToolbar({
    items: [{
        // ...
        widget: 'dxCheckBox',
        options: {
            text: 'Show IDs'
        },
    }]
});
Angular

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. Specify options with an object.

app.component.html
app.module.ts
<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 { }
Vue

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. Specify options with an object. We recommend that you declare the object outside the configuration component to prevent possible issues caused by unnecessary re-rendering.

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

<script>
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>
React

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. Specify options with an object. We recommend that you declare the object outside the configuration component to prevent possible issues caused by unnecessary re-rendering.

App.js
import React from 'react';

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;
NOTE
If you use the Menu UI component as a toolbar item, the adaptivityEnabled property does not apply.
See Also

showText

Specifies when to display the text for the UI component item.

Type:

ShowTextMode

Default Value: 'always'

The text should be specified in the options configuration object.

NOTE
This property is available only if the widget property's value is "dxButton".

template

Specifies a template that should be used to render this item only.

Type:

template

Template Data:

CollectionWidgetItem

The item object to be rendered.

jQuery

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.

The following example adds a custom item to the component.

index.js
$(function() {
    $("#toolbarContainer").dxToolbar({
        // ...
        items: [
            {
                // ...
                template: '<div>Custom Item</div>'
            }
        ]
    });
});
Angular

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a DOM Node of the template's container.

The following example adds a custom item to the component. Note that Angular uses custom templates instead of the template property.

app.component.html
app.component.ts
app.module.ts
<dx-toolbar ... >
    <dxi-item ... >
        <div *dxTemplate>
            <div>Custom Item</div>
        </div>
    </dxi-item>
</dx-toolbar>
import { Component } from '@angular/core';

@Component({
    selector: 'app-root',
    templateUrl: './app.component.html',
    styleUrls: ['./app.component.css']
})
export class AppComponent {
    // ...
}
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 { }
Vue

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a DOM Node of the template's container.

The following example adds a custom item to the component. Note that Vue uses custom templates instead of the template property.

App.vue
<template>
    <DxToolbar ... >
        <dxItem ... >
            <div>Custom Item</div>
        </dxItem>
    </DxToolbar>
</template>

<script>

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

export default {
    components: {
        DxToolbar,
        DxItem
    },
    // ...
}
</script>
React

The following types of the specified value are available.

  • Assign a string containing the name of the required template.
  • Assign a DOM Node of the template's container.

The following example adds a custom item to the component. In React, specify the render or component properties.

App.js
import React from 'react';

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

const renderCustomItem = () => {
    return <div>Custom Item</div>;
}

const App() = () => {
    return (
        <Toolbar ... >
            <Item ...
                render={renderCustomItem}
            >
            </Item>
        </Toolbar>
    );
}
export default App;
See Also

text

Specifies text displayed for the UI component item.

Type:

String

If you use both this property and a template, the template overrides the text.

visible

Specifies whether or not a UI component item must be displayed.

Type:

Boolean

Default Value: true

widget

A UI component that presents a toolbar item. To configure it, use the options object.

Type:

ToolbarItemComponent

NOTE
Import the specified UI component's module when using DevExtreme modules.
See Also