Vue TreeList - toolbar.items

Configures toolbar items.

The toolbar can contain the following elements as items:

  • Predefined controls
    Predefined controls appear on the toolbar depending on whether a specific TreeList feature is enabled. The following table illustrates the dependency:

    Control Name Image Prerequisites
    addRowButton DevExtreme JavaScript jQuery Angular UI component TreeList Toolbar AddButton editing.allowAdding is true
    applyFilterButton DevExtreme JavaScript jQuery Angular UI component TreeList Toolbar ApplyFilterButton filterRow.visible is true and filterRow.applyFilter is set to "onClick"
    columnChooserButton DevExtreme JavaScript jQuery Angular UI component TreeList Toolbar ColumnChooserButton columnChooser.enabled is true
    revertButton DevExtreme JavaScript jQuery Angular UI component TreeList Toolbar RevertButton editing.mode is set to "batch"
    saveButton DevExtreme JavaScript jQuery Angular UI component TreeList Toolbar SaveButton editing.mode is set to "batch" and editing.allowUpdating is true
    searchPanel DevExtreme JavaScript jQuery Angular UI component TreeList Toolbar searchPanel searchPanel.visible is true

    If you need to customize a predefined control, add an object to the items[] array. This object must contain the control's name and properties that you want to customize. If a control does not need customization, simply include its name in the toolbar.items[] array.

    The example below customizes the Column Chooser button, adds an Add Row button, and enables the corresponding TreeList features:

    jQuery
    index.js
    $(function(){
        $("#treeListContainer").dxTreeList({
            // ...
            editing: {
                allowAdding: true
            },
            columnChooser: {
                enabled: true
            },
            toolbar: {
                items: [ "addRowButton", {
                    name: "columnChooserButton",      
                    locateInMenu: "auto",
                }]  
            }
        });
    });
    Angular
    app.component.html
    app.module.ts
    <dx-tree-list ... >
        <dxo-editing [allowAdding]="true"></dxo-editing>
        <dxo-column-chooser [enabled]="true"></dxo-column-chooser>
        <dxo-toolbar>
            <dxi-item name="addRowButton"></dxi-item>
            <dxi-item 
                name="columnChooserButton"
                locateInMenu="auto"
                location="after">
            </dxi-item>
        </dxo-toolbar>
    </dx-tree-list>
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxTreeListModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxTreeListModule,
        ],
        providers: [ ],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue
    App.vue
    <template>
        <DxTreeList ... >
            <DxEditing :allow-adding="true" />
            <DxColumnChooser :enabled="true"/>
            <DxToolbar>
                <DxItem name="addRowButton" />
                <DxItem
                    name="columnChooserButton"
                    locate-in-menu="auto"
                    location="after"
                />
            </DxToolbar>
        </DxTreeList>
    </template>
    <script>
    import { DxTreeList, DxEditing, DxColumnChooser, DxToolbar, DxItem } from 'devextreme-vue/tree-list';
    
    export default {
        components: {
            DxTreeList,
            DxEditing,
            DxToolbar, 
            DxItem,
            DxColumnChooser
        }
    };
    </script>
    React
    App.js
    import TreeList, { Editing, Toolbar, Item, ColumnChooser } from 'devextreme-react/tree-list';
    // ...
    function App() {
        return (
            <TreeList ... >
                <Editing allowAdding={true} />
                <ColumnChooser enabled={true} />
                <Toolbar>
                    <Item name="addRowButton" />
                    <Item
                        name="columnChooserButton"
                        locateInMenu="auto"
                        location="after"
                    />
                </Toolbar>
            </TreeList>
        );
    }
    IMPORTANT
    The TreeList does not display controls missing from the items[] array. Ensure that this array includes controls for all enabled features.
  • DevExtreme components

    jQuery

    You can use DevExtreme components as toolbar items. Set the widget property to specify the component that you want to use and configure the component's options:

    index.js
    $(function(){
        $("#treeListContainer").dxTreeList({
            // ...
            toolbar: {
                items: [{
                    widget: "dxSelectBox",
                    options: {
                        // SelectBox properties are specified here
                    }
                }]  
            }
        });
    });
    Angular

    You can use DevExtreme components as toolbar items. Declare a dxi-item element to add a supported component:

    app.component.html
    app.module.ts
    <dx-tree-list ... >
        <dxo-toolbar>
            <dxi-item>
                <dx-select-box>
                    <!-- SelectBox properties are specified here -->
                </dx-select-box>
            </dxi-item>
        </dxo-toolbar>
    </dx-tree-list>
    import { BrowserModule } from '@angular/platform-browser';
    import { NgModule } from '@angular/core';
    import { AppComponent } from './app.component';
    
    import { DxTreeListModule, DxSelectBoxModule } from 'devextreme-angular';
    
    @NgModule({
        declarations: [
            AppComponent
        ],
        imports: [
            BrowserModule,
            DxTreeListModule,
            DxSelectBoxModule,
        ],
        providers: [ ],
        bootstrap: [AppComponent]
    })
    export class AppModule { }
    Vue

    You can use DevExtreme components as toolbar items. Declare a DxItem element to add a supported component:

    App.vue
    <template>
        <DxTreeList ... >
            <DxToolbar>
                <DxItem>
                    <DxSelectBox>
                        <!-- SelectBox properties are specified here -->
                    </DxSelectBox>
                </DxItem>
            </DxToolbar>
        </DxTreeList>
    </template>
    <script>
    import { DxTreeList, DxToolbar, DxItem } from 'devextreme-vue/tree-list';
    import { DxSelectBox } from 'devextreme-vue/select-box';
    
    export default {
        components: {
            DxTreeList, 
            DxToolbar, 
            DxItem,
            DxSelectBox
        }
    };
    </script>
    React

    You can use DevExtreme components as toolbar items. Declare an Item element to add a supported component:

    App.js
    import { SelectBox } from 'devextreme-react/select-box';
    import TreeList, { Toolbar, Item } from 'devextreme-react/tree-list';
    // ...
    function App() {
        return (
            <TreeList ... >
                <Toolbar>
                    <Item>
                        <SelectBox>
                            {/* SelectBox properties are specified here */}
                        </SelectBox>
                    </Item>
                </Toolbar>
            </TreeList>
        );
    }
  • Custom controls
    To use a custom control, specify a template for it.

DataGrid Demo

cssClass

Specifies a CSS class to be applied to the item.

Selector: css-class
Type:

String

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 TreeList component evaluates the html property's value. This evaluation, however, makes the TreeList 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.

Selector: locate-in-menu
Default Value: 'never'

location

Specifies a location for the item on the toolbar.

Default Value: 'after'

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.

Selector: menu-item-template
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

name

A name used to identify the toolbar item.

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.

Selector: show-text
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.

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. Note that Angular and Vue use custom templates instead of the template property. In React, specify the render or component properties.

jQuery
index.js
$(function() {
    $("#treeListContainer").dxTreeList({
        // ...
        toolbar: {
            items: [
                {
                    // ...
                    template: '<div>Custom Item</div>'
                }
            ]  
        }           
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-tree-list ... >
    <dxo-toolbar>
        <dxi-item ...>
            <div *dxTemplate>
                <div>Custom Item</div>
            </div>
        </dxi-item>
    </dxo-toolbar>
</dx-tree-list>
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 { DxTreeListModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxTreeListModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxTreeList>
        <DxToolbar>
            <DxItem ...>
                <div>Custom Item</div>
            </DxItem>
        </DxToolbar>
    </DxTreeList>
</template>

<script>

import DxTreeList, {
    DxToolbar, DxItem
} from 'devextreme-vue/tree-list';

export default {
    components: {
        DxTreeList,
        DxToolbar,
        DxItem
    },
    // ...
}
</script>
React
App.js
import React from 'react';

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

import TreeList, {
    Toolbar, Item
} from 'devextreme-react/tree-list';

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

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

text

Specifies text displayed for the UI component item.

Type:

String

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.

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