Toolbar Configuration

An object defining configuration options for the dxToolbar widget.

clickAction

An action performed when the widget is clicked.

Type: Action
Default Value: null

Show Example:
jQuery
<div data-bind="dxToolbar: { dataSource: toolbarItems, clickAction: processClick }"></div>
processClick = function () {
  DevExpress.ui.notify("The widget has been clicked", "info", 1000);
};
toolbarItems = [
  { align: 'left', widget: 'button', options: { type: 'back', text: 'Back' }},
  { align: 'right', widget: 'button', options: { icon: 'plus' } },
  { align: 'right', widget: 'button', options: { icon: 'find' } },
  { align: 'center', text: 'Products' }
];

dataSource

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

Type: Object
Default Value: null

The default template of a data source item object may contain the following fields.

  • html - specifies the HTML code inserted into the item element
  • text - specifies the text inserted into the item element
  • widget - specifies the type of the widget representing the item; the available values are 'button', 'dropDownMenu' and 'tabs'
  • align - specifies which toolbar part the item should be aligned by; the available values are 'left', 'right', and 'center'
  • options - specifies the configuration object used to create a widget of the specified type.

Refer to the Data-Bound Application tutorial for more information.

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

disabled

A Boolean value specifying whether or not a component 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 component at runtime.

Show Example:
jQuery
<div class="toolbar" data-bind="dxToolbar: { dataSource: toolbarItems, disabled: toolbarDisabled }"></div><br/>
<div class="dx-fieldset">
  <div class="dx-field">
    <div class="dx-field-label">Disabled</div>
    <div class="dx-field-value" data-bind="dxCheckBox: { checked: toolbarDisabled }"></div>
  </div>
</div>
toolbarItems = [
  { align: 'left', widget: 'button', options: { type: 'back', text: 'Back'} },
  { align: 'right', widget: 'button', options: { icon: 'plus' } },
  { align: 'right', widget: 'button', options: { icon: 'find' } },
  { align: 'center', text: 'Products' }
];

toolbarDisabled = ko.observable(false);
body{
  text-align: center;
}
.toolbar{
  margin: 10px;
}

height

Specifies the height of the widget.

Type: Number|String|function
Default Value: undefined

The option can hold a value of the following types:

  • numeric - 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 + "%"; }).

itemClickAction

An action performed when a collection item is clicked.

Type: Action
Default Value: null

An object passed to the action function assigned to this option can have the following fields besides the basic field set.

  • itemData - contains an object representing the clicked item
  • itemElement - contains an html element representing the clicked item

itemRender

A function used to render collection items.

Type: function
Default Value: null

The rendering function should have the following parameters, and return an HTML string, element, or jQuery object representing the rendered item.

  • itemData - an object representing the rendered item
  • itemIndex - an index of the rendered item
  • itemElement - a container element containing the rendered item

The following is an example of a function used to render an item.

itemRenderedAction

An action performed after a collection item is rendered.

Type: Action
Default Value: null

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.

itemTemplate

The name of the template used to render widget items, or the function returning the template name.

Type: String|function
Default Value: "item"

noDataText

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

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

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
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 (e.g., width:function(){ return baseWidth - 10 + "%"; }).