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
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 = [{
    location: 'before',
    widget: 'dxButton',
    options: {
        type: 'back',
        text: 'Back',
        onClick: function (e) {
            DevExpress.ui.notify("Back button clicked", "success", 5000);
        }
    }
}, {
    locateInMenu: 'always',
    text: "Add",
    onClick: function () {
        // Process item click
    }
}, {
    locateInMenu: 'always',
    text: "Change",
    onClick: function () {
        // Process item click
    }
}, {
    locateInMenu: 'always',
    text: "Remove",
    onClick: function () {
        // Process item click
    }
}, {
    location: 'center',
    text: 'Products'
}];

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

  • jQuery
    Use the dxToolbar jQuery plug-in.

    HTML
    <div id="myToolbar"></div>
    JavaScript
    $("#myToolbar").dxToolbar({
        dataSource: toolbarItems
    });
  • Knockout
    Add a div element and apply dxToolbar binding to this element.

    HTML
    <div data-bind="dxToolbar: {
        dataSource: toolbarDataSource
    }"></div>
    JavaScript
    var viewModel = {
        toolbarDataSource: toolbarItems
    }
    ko.applyBindings(viewModel);
  • AngularJS
    Add a div element and apply the dx-toolbar directive to this element.

    HTML
    <div dx-toolbar="{
        dataSource: toolbarDataSource
    }"></div>
    JavaScript
    var myApp = angular.module('myApp', ['dx']);
    myApp.controller("demoController", function ($scope) {
        $scope.toolbarDataSource = toolbarItems;
    });

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 Installation article.

Since the Toolbar widget is used to display multiple items, it supports common Collection Container widget functionality. You can find detailed information on the principles of working with the widget in the dxToolbar section of the Collection Container Widgets article.

Configuration

An object defining configuration options for the Toolbar widget.

Name Description
dataSource

A data source used to fetch data to be displayed by the widget.

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

height

Specifies the height of the widget.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

itemHoldTimeout

The time period in milliseconds before the onItemHold event is raised.

items

An array of items displayed by the widget.

itemTemplate

The template to be used for rendering items.

menuItemTemplate

The template used to render menu items.

noDataText

The text or HTML markup displayed by the widget if the item collection is empty.

onContentReady

A handler for the contentReady event.

onDisposing

A handler for the disposing event.

onInitialized

A handler for the initialized event.

onItemClick

A handler for the itemClick event.

onItemContextMenu

A handler for the itemContextMenu event.

onItemHold

A handler for the itemHold event.

onItemRendered

A handler for the itemRendered event.

onOptionChanged

A handler for the optionChanged event.

renderAs

Informs the widget about its location in a view HTML markup.

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

visible

A Boolean value specifying whether or not the widget is visible.

width

Specifies the width of the widget.

Methods

This section describes members used to manipulate the widget.

Name Description
beginUpdate()

Prevents the component from refreshing until the endUpdate() method is called.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate() method call.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

repaint()

Redraws the widget.

Events

This section describes events fired by this widget.

Name Description
contentReady

Fires when widget content is ready.

disposing

Fires when the widget is being removed.

initialized

Fires when the widget is initialized.

itemClick

Fires when a widget item is clicked.

itemContextMenu

Fires when the right mouse button is clicked when the pointer is over a widget item, or when the "sustained" (also known as a long press) touch action is performed.

itemHold

Fires when the widget's collection item is being held for the time period specified by the itemHoldTimeout option.

itemRendered

Fires after a collection item is rendered.

optionChanged

Fires after an option of the component is changed.

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