Angular Toolbar API

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

import { DxToolbarModule } from "devextreme-angular"

Type: DxToolbarTypes.default

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"
}];

DevExtreme widgets are integrated with many popular libraries and frameworks. See the Installation section (for JavaScript libraries) or the Prerequisites and Installation section (for ASP.NET MVC framework) to find details on setting up DevExtreme with a particular library or framework.

The following code shows how to create the Toolbar widget using every supported library and framework. For more details on working with widgets in these libraries and frameworks, see the Widget Basics topic for jQuery, Angular, AngularJS, Knockout or ASP.NET MVC.

jQuery

JavaScript

HTML

$(function () {
    $("#toolbar").dxToolbar({
        items: toolbarItems
    });
});

<div id="toolbar"></div>

Angular

HTML

TypeScript

<dx-toolbar [items]="toolbarData"></dx-toolbar>

import { DxToolbarModule, DxButtonModule } from "devextreme-angular";
// ...
export class AppComponent {
    toolbarData = toolbarItems;
}
@NgModule({
     imports: [
         // ...
         DxToolbarModule,
         DxButtonModule
     ],
     // ...
 })

AngularJS

HTML

JavaScript

<div ng-controller="DemoController">
    <div dx-toolbar="{
        items: toolbarData
    }"></div>
</div>

angular.module("DemoApp", ["dx"])
    .controller("DemoController", function DemoController($scope) {
        $scope.toolbarData = toolbarItems;
    });

Knockout

HTML

JavaScript

<div data-bind="dxToolbar: {
    items: toolbarData
}"></div>

var viewModel = {
    toolbarData: toolbarItems
};
ko.applyBindings(viewModel);

ASP.NET MVC Controls

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)
)

View Demo

Configuration

An object defining configuration options for the Toolbar widget.

Name	Description
dataSource	Binds the widget to data.
disabled	Specifies whether the widget responds to user interaction.
elementAttr	Specifies the attributes to be attached to the widget's root element.
height	Specifies the widget's height.
hint	Specifies text for a hint that appears when a user pauses on the widget.
hoverStateEnabled	Specifies whether the widget changes its state when a user pauses on it.
itemHoldTimeout	The time period in milliseconds before the onItemHold event is raised.
items	An array of items displayed by the widget.
itemTemplate	Specifies a custom template for items.
menuItemTemplate	Specifies a custom template for menu items.
noDataText	The text or HTML markup displayed by the widget if the item collection is empty.
onContentReady	A function that is executed when the widget's content is ready and each time the content is changed.
onDisposing	A function that is executed before the widget is disposed of.
onInitialized	A function used in JavaScript frameworks to save the widget instance.
onItemClick	A function that is executed when a collection item is clicked or tapped.
onItemContextMenu	A function that is executed when a collection item is right-clicked or pressed.
onItemHold	A function that is executed when a collection item has been held for a specified period.
onItemRendered	A function that is executed after a collection item is rendered.
onOptionChanged	A function that is executed after a widget option is changed.
renderAs	Informs the widget about its location in a view HTML markup.
rtlEnabled	Switches the widget to a right-to-left representation.
visible	Specifies whether the widget is visible.
width	Specifies the widget's width.

Methods

This section describes members used to manipulate the widget.

Name	Description
beginUpdate()	Prevents the widget from refreshing until the endUpdate() method is called.
defaultOptions(rule)	Specifies the device-dependent default configuration options for this component.
dispose()	Disposes of all the resources allocated to the Toolbar instance.
element()	Gets the root widget element.
endUpdate()	Refreshes the widget after a call of the beginUpdate() method.
getDataSource()	Gets the DataSource instance.
getInstance(element)	Gets the instance of a widget found using its DOM node.
instance()	Gets the widget's instance. Use it to access other methods of the widget.
off(eventName)	Detaches all event handlers from a single event.
off(eventName, eventHandler)	Detaches a particular event handler from a single event.
on(eventName, eventHandler)	Subscribes to an event.
on(events)	Subscribes to events.
option()	Gets all widget options.
option(optionName)	Gets the value of a single option.
option(optionName, optionValue)	Updates the value of a single option.
option(options)	Updates the values of several options.
repaint()	Repaints the widget without reloading data. Call it to update the widget's markup.

Events

This section describes events fired by this widget.

Name	Description
contentReady	Raised when the widget's content is ready.
disposing	Raised before the widget is disposed of.
initialized	Raised only once, after the widget is initialized.
itemClick	Raised when a collection item is clicked or tapped.
itemContextMenu	Raised when a collection item is right-clicked or pressed.
itemHold	Raised when a collection item has been held for a specified period.
itemRendered	Raised after a collection item is rendered.
optionChanged	Raised after a widget option is changed.

Default Item Template

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

Type:

Object

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.

Angular Toolbar API

jQuery

Angular

AngularJS

Knockout

ASP.NET MVC Controls

See Also

Configuration

Methods

Events

See Also

Default Item Template

See Also