Configuration datasource

A data source used to display toolbar items.

Default Value: null

You can assign an array directly to this option, as well as use the Data Layer provided by the PhoneJS library.

To display widget items, a default template can be used. This template is based on the data source fields that are listed below. Alternatively, you can implement a custom item template. For details refer to the Customize Widget Item Appearance topic.

Show Example:
jQuery
<div data-bind="dxToolbar: { dataSource: toolbarItems }"></div>
toolbarItems = [
  { location: 'left', widget: 'button', options: { type: 'back', text: 'Back' } },
  { location: 'right', widget: 'button', options: { icon: 'plus' } },
  { location: 'right', widget: 'button', options: { icon: 'find' } },
  { location: 'center', text: 'Products' }
];

disabled

Specifies whether a widget item must be displayed disabled.

Type: Boolean
Default Value: false

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that items are displayed disabled or enabled according to the specified value.

html

Specifies html code inserted into the widget item element.

Type: String

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that the required markup is used to display the widget items.

location

Specifies a location for the item on the toolbar.

Type: String
Default Value: 'center'
Accepted Values: 'left'|'right'|'center'|'menu'

Whatever template you use for widget items (default or custom), they will be located according to the value specified for the location field in the item data source object.

If 'menu' is set as the location field's value, the toolbar item is added to the toolbar's overflow menu. This menu is displayed by the dxDropDownMenu, dxPopover, dxActionSheet or application bar widget based on the device on which the application is running. You can introduce a custom template for menu items using the menuItemTemplate or menuItemRender option.

options

Specifies a configuration object for the widget that presents a toolbar item.

Type: Object

This data source field is used by a default item template. If you use the default template for your widget items, and specify the widget field in the toolbar data source, you can specify the options field as well. Set the configuration options that are exposed by the configuration object of the specified widget.

template

Specifies an item template that should be used to render this item only.

Type: String|function|DOM Node|jQuery
Return Value: String|jQuery
A template name or a template container.

Whether you use a default or a custom template for widget items, you can specify a specific template for a particular item. To do so, set the template field for the data source object of this item. The following types of the specified value are available.

  • Assign a string representing the name of the required template
  • Assign a jQuery object representing the template's container
  • Assign a DOM Node representing the template's container
  • Assign a function that returns the jQuery object or a DOM Node representing the template's container

To learn more about item templates, refer to the Customize Widget Item Appearance topic.

text

Specifies text displayed for the widget item.

Type: String

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that the required text is displayed for the widget items.

visible

Specifies whether a widget item must be displayed.

Type: Boolean
Default Value: true

This data source field is used by a default item template. If you use the default template for your widget items, you can specify this field in the widget data source so that items are visible or not according to the specified value.

widget

A widget that presents a toolbar item.

Type: String
Accepted Values: 'button'|'tabs'

This data source field is used by a default item template. If you use the default template for your widget items, you can specify the widget field in the data source to specify the widget by which a toolbar item must be displayed. Set the configuration options that are exposed by the configuration object of the specified widget. For this purpose, specify the options field in the data source.