Toolbar

The Toolbar is a widget containing items that usually manage screen content. Those items can be plain text or widgets.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/toolbar
Export: default
Toolbar interactive configuration
Copy Code
Copy to Codepen
$("#toolbar").dxToolbar({
});

The main option you should specify when creating a widget is the dataSource. The following code snippet demonstrates an example of an array that can be passed to the dataSource option of the Toolbar widget.

JavaScript
var toolbarItems = [{
    widget: 'dxButton',
    options: {
        type: 'back',
        text: 'Back'
    },
    location: 'before'
}, {
    text: 'Add',
    locateInMenu: 'always'
}, {
    text: 'Change',
    locateInMenu: 'always'
}, {
    text: 'Products',
    location: 'center'
}];

You can create the widget using one of the following approaches.

  • jQuery

    HTML
    <div id="toolbar"></div>
    JavaScript
    $(function () {
        $("#toolbar").dxToolbar({
            items: toolbarItems
        });
    });
  • Angular

    HTML
    <dx-toolbar [items]="toolbarData"></dx-toolbar>
    JavaScript
    export class AppComponent {
        toolbarData = toolbarItems;
    }
  • AngularJS

    HTML
    <div ng-controller="DemoController">
        <div dx-toolbar="{
            items: toolbarData
        }"></div>
    </div>
    JavaScript
    angular.module('DemoApp', ['dx'])
        .controller('DemoController', function DemoController($scope) {
            $scope.toolbarData = toolbarItems;
        });
  • Knockout

    HTML
    <div data-bind="dxToolbar: {
        items: toolbarData
    }"></div>
    JavaScript
    var viewModel = {
        toolbarData: toolbarItems
    };
    ko.applyBindings(viewModel);
  • ASP.NET MVC Wrappers

    Razor C#
    Razor VB
    @(Html.DevExtreme().Toolbar()
        .ID("toolbar")
        .Items(items => {
            items.Add()
                .Widget(w => w.Button()
                    .Type(ButtonType.Back)
                    .Text("Back"))
                .Location(ToolbarItemLocation.Before);
            items.Add()
                .Text("Add")
                .LocateInMenu(ToolbarItemLocateInMenuMode.Always);
            items.Add()
                .Text("Change")
                .LocateInMenu(ToolbarItemLocateInMenuMode.Always);
            items.Add()
                .Text("Products")
                .Location(ToolbarItemLocation.Center);
        })
    )
    @(Html.DevExtreme().Toolbar() _
        .ID("toolbar") _
        .Items(Sub(items)
            items.Add() _
                .Widget(Function(w)
                    Return w.Button() _
                            .Type(ButtonType.Back) _
                            .Text("Back")
                End Function) _
                .Location(ToolbarItemLocation.Before)
            items.Add() _
                .Text("Add") _
                .LocateInMenu(ToolbarItemLocateInMenuMode.Always)
            items.Add() _
                .Text("Change") _
                .LocateInMenu(ToolbarItemLocateInMenuMode.Always)
            items.Add() _
                .Text("Products") _
                .Location(ToolbarItemLocation.Center)
        End Sub)
    )

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the topics in the Installation section.

See Also
Show Example:
AngularJS
Knockout
jQuery

Configuration

An object defining configuration options for the Toolbar widget.

Methods

This section describes members used to manipulate the widget.

Events

This section describes events fired by this widget.

Default Item Template

This section lists the data source fields that are used in a default template for toolbar items.

By default, a predefined item template is applied to display the items of this widget. This template is based on certain fields of the data source provided for this widget. Below is a list of these fields. If the default item template is not appropriate for your task, implement a custom item template based on these or other fields of your data source.

See Also