JavaScript/jQuery Toolbar - items
An array of items displayed by the UI component.
Array<String | dxToolbarItem | Object>
The items array can contain:
- Strings
- Objects with fields described in this section
- Objects with any other fields. In this case, specify the itemTemplate.
If you need to update the UI component items, reassign the entire items array as shown in the following example:
toolbarInstance.option('items', newItems);
As an alternative to items, you can use the dataSource property. It accepts the DataSource object, whose underlying stores provide an API that allows you to update individual items without reassigning the entire item collection.
component
An alias for the template property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
disabled
Specifies whether the UI component item responds to user interaction.
locateInMenu
Specifies when to display an item in the toolbar's overflow menu.
Use the ToolbarItemLocateInMenuMode
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Always
, Never
, and Auto
.
location
Specifies a location for the item on the toolbar.
Whatever template you use for UI component items (default or a custom) will be located according to the value specified for the location field in the item data source object.
Use the ToolbarItemLocation
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Before
, After
, and Center
.
See Also
menuItemComponent
An alias for the menuItemTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
menuItemRender
An alias for the menuItemTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
menuItemTemplate
Specifies a template that should be used to render a menu item.
The following types of the specified value are available.
- Assign a string containing the name of the required template.
- 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.
See Also
options
Configures the DevExtreme UI component used as a toolbar item.
options should contain the properties of the DevExtreme UI component specified in the widget property. Because of this dependency, options cannot be typed and are not implemented as nested configuration components in Angular, Vue, and React. In these frameworks, specify options with an object. We recommend that you declare the object outside the configuration component in Vue and React to prevent possible issues caused by unnecessary re-rendering.
Angular
<dx-toolbar ... > <dxi-item widget="dxCheckBox" [options]="{ text: 'Show IDs' }"> </dxi-item> </dx-toolbar>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxToolbarModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxToolbarModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxToolbar ... > <DxItem ... widget="dxCheckBox" :options="checkBoxOptions" /> </DxToolbar> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxToolbar, { DxItem } from 'devextreme-vue/toolbar'; export default { components: { DxToolbar, DxItem }, data() { return { checkBoxOptions: { text: 'Show IDs' } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import Toolbar, { Item } from 'devextreme-react/toolbar'; class App extends React.Component { checkBoxOptions = { text: 'Show IDs' }; render() { return ( <Toolbar ... > <Item widget="dxCheckBox" options={this.checkBoxOptions} /> </Toolbar> ); } } export default App;
See Also
render
An alias for the template property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
showText
Specifies when to display the text for the UI component item.
The text should be specified in the options configuration object.
Use the ToolbarItemShowTextMode
enum to specify this property when the UI component is used as an ASP.NET MVC 5 Control or a DevExtreme-Based ASP.NET Core Control. This enum accepts the following values: Always
and InMenu
.
template
Specifies a template that should be used to render this item only.
The following types of the specified value are available.
- Assign a string containing the name of the required template.
- 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.
See Also
widget
A UI component that presents a toolbar item. To configure it, use the options object.
When using ASP.NET MVC 5 Controls or DevExtreme-Based ASP.NET Core Controls, configure this property with a lambda expression as follows:
@(Html.DevExtreme().Toolbar() .Items(items => { items.Add().Widget(w => w // Instead of Button here you can use any other UI component .Button() .Text("Back") ); }) )
@(Html.DevExtreme().Toolbar() _ .Items(Sub(items) items.Add().Widget(Function(w) ' Instead of Button here you can use any other UI component Return w.Button().Text("Back") End Function) End Sub) )
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.