Toolbar Configuration

An object defining configuration options for the dxToolbar widget.

dataSource

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

Default Value: null

You can assign an array directly to this option as well as use the Data Source provided by the DevExtreme library.

NOTE: If the data source is specified using the dataSource option, use the items option only for reading. Updating data items using the items option may cause unexpected results.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API. Alternatively, you can implement a custom item template.

See Also
Show Example:
AngularJS
Knockout
jQuery
<div ng-controller="demoController" style="height:100%;">
    <div dx-toolbar="{
        dataSource: toolbarItems
    }"></div>
</div>
var myApp = angular.module('myApp', ['dx']);
myApp.controller("demoController", function ($scope) {
    $scope.toolbarItems = [
      { location: 'before', widget: 'button', options: { type: 'back', text: 'Back' } },
      { location: 'after', widget: 'button', options: { icon: 'plus' } },
      { location: 'after', widget: 'button', options: { icon: 'find' } },
      { location: 'center', text: 'Products' }
    ];
});
angular.element(document).ready(function () {
    angular.bootstrap(document, ['myApp']);
});
<div data-bind="dxToolbar: { dataSource: toolbarItems }"></div>
var myViewModel = {
    toolbarItems: [
      { location: 'before', widget: 'button', options: { type: 'back', text: 'Back' } },
      { location: 'after', widget: 'button', options: { icon: 'plus' } },
      { location: 'after', widget: 'button', options: { icon: 'find' } },
      { location: 'center', text: 'Products' }
    ]
}
ko.applyBindings(myViewModel);
<div id="myToolbar"></div>
$("#myToolbar").dxToolbar({
    dataSource: [
      { location: 'before', widget: 'button', options: { type: 'back', text: 'Back' } },
      { location: 'after', widget: 'button', options: { icon: 'plus' } },
      { location: 'after', widget: 'button', options: { icon: 'find' } },
      { location: 'center', text: 'Products' }
    ]
});

disabled

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

Type: Boolean
Default Value: false

Create an observable variable and assign it to this option to specify the availability of the widget at runtime.

Show Example:
AngularJS
Knockout
jQuery
<div ng-controller="demoController" style="height:100%;">
    <div dx-toolbar="{
        items: toolbarItems,
        bindingOptions: {
            disabled: 'toolbarDisabled'
        }
    }"></div>
    <div class="dx-fieldset">
        <div class="dx-field">
            <div class="dx-field-label">disabled</div>
            <div class="dx-field-value" ng-model="toolbarDisabled" dx-switch="{ }"></div>
        </div>
    </div>
</div>
var myApp = angular.module('myApp', ['dx']);
myApp.controller("demoController", function ($scope) {
    $scope.toolbarItems = [
        { location: 'before', widget: 'button', options: { type: 'back', text: 'Back' } },
        { location: 'after', widget: 'button', options: { icon: 'plus' } },
        { location: 'after', widget: 'button', options: { icon: 'find' } },
        { location: 'center', text: 'Products' }
    ];
    $scope.toolbarDisabled = false;
});
angular.element(document).ready(function () {
    angular.bootstrap(document, ['myApp']);
});
<div data-bind="dxToolbar: {
    items: toolbarItems,
    disabled: toolbarDisabled
}"></div>
<div class="dx-fieldset">
    <div class="dx-field">
        <div class="dx-field-label">disabled</div>
        <div class="dx-field-value" data-bind="dxSwitch:{ 
            value: toolbarDisabled
        }"></div>
    </div>
</div>
var myViewModel = {
    toolbarItems: [
        { location: 'before', widget: 'button', options: { type: 'back', text: 'Back' } },
        { location: 'after', widget: 'button', options: { icon: 'plus' } },
        { location: 'after', widget: 'button', options: { icon: 'find' } },
        { location: 'center', text: 'Products' }
    ],
    toolbarDisabled: ko.observable(false)
}
ko.applyBindings(myViewModel);
<div id="myToolbar"></div>
<div class="dx-fieldset">
    <div class="dx-field">
        <div class="dx-field-label">disabled</div>
        <div class="dx-field-value" id="disabledSelector"></div>
    </div>
</div>
$("#myToolbar").dxToolbar({
    items: [
        { location: 'before', widget: 'button', options: { type: 'back', text: 'Back' } },
        { location: 'after', widget: 'button', options: { icon: 'plus' } },
        { location: 'after', widget: 'button', options: { icon: 'find' } },
        { location: 'center', text: 'Products' }
    ]
});
$("#disabledSelector").dxSwitch({
    value: false,
    onValueChanged: function (e) {
        $("#myToolbar").dxToolbar("instance").option("disabled", e.value);
    }
});

height

Specifies the height of the widget.

Type: Number|String| function
Return Value: Number|String
The widget height.
Default Value: undefined

The option can hold a value of the following types.

  • number
    The height of the widget in pixels

  • string
    A CSS measurement of the widget height (e.g., "55px", "80%", "auto" and "inherit")

  • function
    A function returning the widget height (e.g., height:function(){ return baseHeight - 10 + "%"; })

hint

Specifies the text of the hint displayed for the widget.

Type: String
Default Value: undefined

hoverStateEnabled

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

Type: Boolean
Default Value: false

itemHoldTimeout

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

Type: Number
Default Value: 750

items

An array of items displayed by the widget.

Type: Array

You can use the dataSource option instead. Unlike the items option, the dataSource option can take on the DataSource configuration object as well as a simple array.

NOTE: If you need to modify the data source specified using the items option at runtime, do it only with the help of the items option. Updating data items using the dataSource option may cause unexpected results.

To display widget items, a default template can be used. This template is based on the data source fields that are listed in the Default Item Template section of the widget's API. Alternatively, you can implement a custom item template.

See Also

itemTemplate

The template to be used for rendering items.

Type: String| function |DOM Node|jQuery
Function parameters:
itemData: Object
The item object to be rendered.
itemIndex: Number
The index of the item to be rendered.
itemElement: jQuery
An HTML element of the item to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: 'item'

NOTE: A binding context of an item template is the data source object that corresponds to the currently rendered item. So, you can bind template elements to the item object's fields directly (see the code above). To access another binding context within an item template, use Knockout/Angular binding variables.

See Also
Show Example:
AngularJS
Knockout
jQuery
<div ng-controller="demoController" style="height:100%;">
    <div dx-toolbar="{
        dataSource: toolbarItems,
        itemTemplate: 'customItem',
        onItemClick: itemClickHandler
    }">
        <div data-options="dxTemplate: { name: 'title' }">
            <b style="color:red;">{{text}}</b>
        </div>
        <div data-options="dxTemplate: { name: 'customItem' }">
            <i style="margin:0 5px 0 5px; cursor: pointer;">{{text}}</i>
        </div>
    </div>
</div>
var myApp = angular.module('myApp', ['dx']);
myApp.controller("demoController", function ($scope) {
    $scope.itemClickHandler = function (e) {
        DevExpress.ui.notify(e.itemData.text + " item clicked", "success", 1500);
    };
    $scope.toolbarItems = [
        { location: 'before', text: 'Back' },
        { location: 'after', text: 'Add' },
        { location: 'after', text: 'Find' },
        { location: 'before', text: 'Products', template: "title" }
    ];
});
angular.element(document).ready(function () {
    angular.bootstrap(document, ['myApp']);
});
<div data-bind="dxToolbar: {
    dataSource: toolbarItems,
    itemTemplate: 'customItem',
    onItemClick: itemClickHandler
}">
    <div data-options="dxTemplate: { name: 'title' }">
        <b style="color:red;" data-bind="text: text"></b>
    </div>
    <div data-options="dxTemplate: { name: 'customItem' }">
        <i style="margin:0 5px 0 5px; cursor: pointer;" data-bind="text: text"></i>
    </div>
</div>
var myViewModel = {
    itemClickHandler: function (e) {
        DevExpress.ui.notify(e.itemData.text + " item clicked", "success", 1500);
    },
    toolbarItems: [
        { location: 'before', text: 'Back' },
        { location: 'after', text: 'Add' },
        { location: 'after', text: 'Find' },
        { location: 'before', text: 'Products', template: "title" }
    ]
}
ko.applyBindings(myViewModel);
<div id="myToolbar"></div>
var titleTemplate = function (itemData, itemIndex, itemElement) {
    itemElement.append("<p  style='color:red;'>" + itemData.text + "</p>");
};
$("#myToolbar").dxToolbar({
    onItemClick: function (e) {
        DevExpress.ui.notify(e.itemData.text + " item clicked", "success", 1500);
    },
    items: [
        { location: 'before', text: 'Back' },
        { location: 'after', text: 'Add' },
        { location: 'after', text: 'Find' },
        { location: 'before', text: 'Products', template: titleTemplate }
    ],
    itemTemplate: function (itemData, itemIndex, itemElement) {
        itemElement.append("<i style='margin:0 5px 0 5px; cursor: pointer;'>" + itemData.text + "</i>");
    }
});

menuItemTemplate

The template used to render menu items.

Type: String| function |DOM Node|jQuery
Function parameters:
itemData: Object
The menu item object to be rendered.
itemIndex: Number
The index of the menu item to be rendered.
itemElement: jQuery
An HTML element of the menu item to be rendered.
Return Value: String|DOM Node|jQuery
A template name or a template container.
Default Value: 'menuItem'

As in all container widgets in DevExtreme, toolbar menu items are displayed by a default HTML template. This template is based on certain fields of the data source (these fields are listed in the description of the widgets that are used to present a toolbar menu). You can define a custom item template that will use specific fields of the data source.

NOTE: A binding context of a menu item template is the data source object that corresponds to the currently rendered item. So, you can bind template elements to the item object's fields directly (see the code above). To access another binding context within a menu item template, use the Knockout/Angular binding variables.

See Also

You can define a markup for a menu item template as a separate element as demonstrated below.

HTML
<script type="text/html" id="person-template">
    <h3 data-bind="text: name"></h3>
    <p>Address: <span data-bind="text: address"></span></p>
</script>

To set this template as a menu item template, assign one of the following values to the menuItemTemplate option.

  • 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
Show Example:
AngularJS
Knockout
jQuery

noDataText

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

Type: String
Default Value: 'No data to display'

onContentReady

A handler for the contentReady event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
Default Value: null

Assign a function to perform a custom action when widget content is ready.

onDisposing

A handler for the disposing event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
Default Value: null

Assign a function to perform a custom action when the widget is being removed.

NOTE: The function assigned to this option is executed only if the widget is removed using the remove(), empty(), or html() jQuery methods.

onInitialized

A handler for the initialized event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
Default Value: null

Assign a function to perform a custom action when the widget is initialized.

onItemClick

A handler for the itemClick event.

Type: function |String
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
itemData: Object
The data that is bound to the clicked item.
itemElement: jQuery
An HTML element of the item.
itemIndex: Number
Specifies the index of the clicked item.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
Default Value: null

Assign a function to perform a custom action when a widget item is clicked.

To navigate to a specific URL when the itemClick event fires, assign that URL or the anchor part (#) of that URL directly to this option as a string.

onItemContextMenu

A handler for the itemContextMenu event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
itemData: Object
The data that is bound to the item.
itemElement: jQuery
An HTML element of the item.
itemIndex: Number
Specifies the index of the item.
jQueryEvent: jQuery.Event
Specifies the jQuery event that caused action execution.
Default Value: null

Assign a function to perform a custom action 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.

onItemHold

A handler for the itemHold event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
itemData: Object
The data that is bound to the item being held.
itemElement: jQuery
An HTML element of the item.
itemIndex: Number
Specifies the index of the item being held.
Default Value: null

Assign a function to perform a custom action when the widget's collection item is being held for a specified time period (see the itemHoldTimeout option).

onItemRendered

A handler for the itemRendered event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data available for binding against the element. Available only in the Knockout and AngularJS approaches.
itemData: Object
The data that is bound to the item to be rendered.
itemElement: jQuery
An HTML element of the item.
itemIndex: Number
Specifies the index of the rendered item.
Default Value: null

Assign a function to perform a custom action after a collection item is rendered.

onOptionChanged

A handler for the optionChanged event.

Type: function
Function parameters:
e: Object
Provides function parameters.
Object structure:
component: Object
Provides access to the widget instance.
name: String
Specifies the name of the option whose value is changed.
fullName: String
Specifies a full name of the option whose value is changed. The full name is formed by concatenating the names of the options that are presented in the hierarchy of the given option. The names are delimited by commas.
value: any
Specifies a new value for the option.
element: jQuery
An HTML element of the widget.
model: Object
Provides access to the data that is available for binding against the element. Available only in the Knockout and AngularJS approaches.
Default Value: null

Assign a function to perform a custom action after an option of the component is changed.

renderAs

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

Type: String
Default Value: 'topToolbar'
Accepted Values: 'topToolbar' | 'bottomToolbar'

When configuring the dxToolbar widget, use the renderAs option to specify the location of this widget in a view HTML template. Depending on the value that you set for this option, the widget's appearance will be adjusted accordingly. For instance, when a toolbar is located at the top of a view on an iOS device, it must be separated by a border from the bottom view content. In addition, when a toolbar is located at the bottom of a view on a Windows Phone 8 device, this toolbar looks and behaves like a native application bar.

rtlEnabled

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

Type: Boolean
Default Value: false

If you need to switch the display of this DevExtreme component to right-to-left, enable a specifically designed configuration option - rtlEnabled. When this option is set to true, the text flows from right to left, and the layout the component's elements is reversed. To switch the entire application/site to a right-to-left representation, use the static DevExpress.rtlEnabled field.

visible

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

Type: Boolean
Default Value: true

width

Specifies the width of the widget.

Type: Number|String| function
Return Value: Number|String
The widget width.
Default Value: undefined

The option can hold a value of the following types.

  • numeric
    The widget width in pixels.
  • string
    A CSS measurement of the widget width (e.g., "55px", "80%", "auto" and "inherit").
  • function
    The function returning the widget width. For example, see the following code.

    JavaScript
    width: function () { 
        return baseWidth - 10 + "%";
    }