React Gantt - toolbar.items
The Gantt UI component allows you to add default and create custom toolbar items.
jQuery
$(function () { $("#gantt").dxGantt({ //... toolbar: { items: [ 'undo', 'redo', 'separator', { widget: "dxButton", options: { text: "About", icon: "info", stylingMode: "text", onClick: function () { // ... } } } ] } }); });
Angular
<dx-gantt> <dxo-toolbar> <dxi-item name="undo"></dxi-item> <dxi-item name="redo"></dxi-item> <dxi-item name="separator"></dxi-item> <dxi-item widget="dxButton" [options]="customButtonOptions"> </dxi-item> </dxo-toolbar> <dxi-column dataField="title" caption="Subject" [width]="300"></dxi-column> <dxi-column dataField="start" caption="Start Date"></dxi-column> <dxi-column dataField="end" caption="End Date"></dxi-column> </dx-gantt>
import { Component } from '@angular/core'; import { Service } from './app.service'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'], providers: [Service] }) export class AppComponent { constructor(service: Service) { this.customButtonOptions = { text: 'About', icon: 'info', stylingMode: 'text', onClick: () => { // ... } }; } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxGanttModule } from 'devextreme-angular'; @NgModule({ imports: [ BrowserModule, DxGanttModule ], declarations: [AppComponent], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxGantt> <DxToolbar> <DxItem name="undo"/> <DxItem name="redo"/> <DxItem name="separator"/> <DxItem :options="aboutButtonOptions" widget="dxButton" /> </DxToolbar> </DxGantt> </template> <script> import 'devextreme/dist/css/dx.light.css'; import 'devexpress-gantt/dist/dx-gantt.css'; import { DxGantt, DxToolbar, DxItem // ... } from 'devextreme-vue/gantt'; export default { components: { DxGantt, DxToolbar, DxItem } data() { return { aboutButtonOptions: { text: 'About', icon: 'info', stylingMode: 'text', onClick: () => { // ... } } }; } }; </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import 'devexpress-gantt/dist/dx-gantt.css'; import Gantt, { // ... } from 'devextreme-react/gantt'; const App = () => { const aboutButtonOptions = { text: 'About', icon: 'info', stylingMode: 'text', onClick: 'onItemClick' }; const onItemClick = (e) => { // ... }; return ( <Gantt> <Toolbar> <Item name="undo" /> <Item name="redo" /> <Item name="separator" /> <Item widget="dxButton" options={this.aboutButtonOptions} /> </Toolbar> {/* ... */} </Gantt> ); }; export default App;
ASP.NET Core Controls
@(Html.DevExtreme().Gantt() .Toolbar(t => { t.Items(i => { i.Add().Name(GanttToolbarItem.Undo); i.Add().Name(GanttToolbarItem.Redo); i.Add().Name(GanttToolbarItem.Separator); i.Add().Name("About") .Widget(widget => widget.Button() .OnClick("showInfo") .Icon("info") .Text("About") .StylingMode(ButtonStylingMode.Text) );
​ }); }) // ... )
<script type="text/javascript"> function showInfo() { // ... } </script>
ASP.NET MVC Controls
@(Html.DevExtreme().Gantt() .Toolbar(t => { t.Items(i => { i.Add().Name(GanttToolbarItem.Undo); i.Add().Name(GanttToolbarItem.Redo); i.Add().Name(GanttToolbarItem.Separator); i.Add().Name("About") .Widget(widget => widget.Button() .OnClick("showInfo") .Icon("info") .Text("About") .StylingMode(ButtonStylingMode.Text) );
​ }); }) // ... )
<script type="text/javascript"> function showInfo() { // ... } </script>
component
An alias for the template property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
html
The Gantt component evaluates the html property's value. This evaluation, however, makes the Gantt potentially vulnerable to XSS attacks. To guard against these attacks, encode the HTML markup before you assign it to the html property. Refer to the following help topic for more information: Potentially Vulnerable API - html.
You can use the text property as a safe alternative.
location
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.
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
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.
jQuery
$(function() { $("#toolbar").dxToolbar({ items: [{ // ... menuItemTemplate (data, index) { return $(`<div><i class='dx-icon-favorites'></i>${data.options.text}</div>`); } }], }); });
Angular
<dx-toolbar> <dxi-item ... menuItemTemplate="menu-item" > </dxi-item> <div *dxTemplate="let data of 'menu-item'"> <i class="dx-icon-favorites"></i> {{data.options.text}} </div> </dx-toolbar>
Vue
<template> <DxToolbar> <dxItem ... menu-item-template="menu-item" > </dxItem> <template #menu-item="{ data }"> <i class="dx-icon-favorites"></i> {{data.options.text}} </template> </DxToolbar> </template> <script> // ... </script>
React
import React from 'react'; import Toolbar, { Item } from 'devextreme-react/toolbar'; const renderMenuItem = (data) => { return <div><i class="dx-icon-favorites"></i> {data.options.text}</div>; } function App() { return ( <Toolbar> <Item ... menuItemRender={renderMenuItem} > </Item> </Toolbar> ); } export default App;
See Also
name
options
jQuery
$('#toolbar').dxToolbar({ items: [{ // ... widget: 'dxCheckBox', options: { text: 'Show IDs' }, }] });
Angular
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. Specify options with an object.
<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
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. Specify options with an object. We recommend that you declare the object outside the configuration component to prevent possible issues caused by unnecessary re-rendering.
<template> <DxToolbar ... > <DxItem ... widget="dxCheckBox" :options="checkBoxOptions" /> </DxToolbar> </template> <script> 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
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. Specify options with an object. We recommend that you declare the object outside the configuration component to prevent possible issues caused by unnecessary re-rendering.
import React from 'react'; 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.
template
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.
The following example adds a custom item to the component. Note that Angular and Vue use custom templates instead of the template property. In React, specify the render or component properties.
jQuery
$(function() { $("#ganttContainer").dxGantt({ // ... toolbar: { items: [ { // ... template: '<div>Custom Item</div>' } ] } }); });
Angular
<dx-gantt ... > <dxo-toolbar> <dxi-item ...> <div *dxTemplate> <div>Custom Item</div> </div> </dxi-item> </dxo-toolbar> </dx-gantt>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxGanttModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxGanttModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxGantt> <DxToolbar> <DxItem ...> <div>Custom Item</div> </DxItem> </DxToolbar> </DxGantt> </template> <script> import DxGantt, { DxToolbar, DxItem } from 'devextreme-vue/gantt'; export default { components: { DxGantt, DxToolbar, DxItem }, // ... } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import Gantt, { Toolbar, Item } from 'devextreme-react/gantt'; const renderCustomItem = () => { return <div>Custom Item</div>; } function App() { return ( <Gantt ... > <Toolbar> <Item ... render={renderCustomItem} > </Item> </Toolbar> </Gantt> ); } export default App;
See Also
widget
A UI component that presents a toolbar item. To configure it, use the options object.
See Also
If you have technical questions, please create a support ticket in the DevExpress Support Center.