React Popup - toolbarItems
Configures toolbar items.
In the following code, two items are defined on the toolbar: one is plain text, another is the Button UI component:
jQuery
$(function() { $("#popupContainer").dxPopup({ // ... toolbarItems: [{ text: "Title", location: "before" }, { widget: "dxButton", location: "after", options: { text: "Refresh", onClick: function(e) { /* ... */ } } }] }); });
<div id="popupContainer"> <p>Popup content</p> </div>
Angular
<dx-popup ... > <div *dxTemplate="let data of 'content'"> <p>Popup content</p> </div> <dxi-toolbar-item text="Title" location="before"> </dxi-toolbar-item> <dxi-toolbar-item widget="dxButton" location="after" [options]="{ text: 'Refresh', onClick: refresh }"> </dxi-toolbar-item> </dx-popup>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { refresh () { /* ... */ } }
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPopupModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPopupModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }
ASP.NET MVC Controls
@(Html.DevExtreme().Popup() <!-- ... --> .ContentTemplate(@<text> <p>Popup content</p> </text>) .ToolbarItems(ti => { ti.Add() .Text("Title") .Location(ToolbarItemLocation.Before); ti.Add() .Widget(w => w.Button() .Text("Refresh") .OnClick("refresh")) .Location(ToolbarItemLocation.After); } ) <script type="text/javascript"> function refresh() { /* ... */ } </script>
Vue
<template> <DxPopup ... > <p>Popup content</p> <DxToolbarItem text="Title" location="before"> </DxToolbarItem> <DxToolbarItem widget="dxButton" :options="buttonOptions" location="after"> </DxToolbarItem> </DxPopup> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxPopup, { DxToolbarItem } from 'devextreme-vue/popup'; export default { components: { DxPopup }, data() { return { buttonOptions: { text: 'Refresh', onClick: function(e) { /* ... */ } } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import { Popup, ToolbarItem } from 'devextreme-react/popup'; class App extends React.Component { constructor() { this.buttonOptions = { text: 'Refresh', onClick: function(e) { /* ... */ } }; } render() { return ( <Popup ... > <p>Popup Content</p> <ToolbarItem text="Title" location="before"> </ToolbarItem> <ToolbarItem widget="dxButton" location="after" options={this.buttonOptions}> </ToolbarItem> </Popup> ); } } export default App;
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.
html
Specifies the HTML markup to be inserted into the item element.
The Popup component evaluates the html property's value. This evaluation, however, makes the Popup 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.
locateInMenu
Specifies when to display an item in the toolbar's overflow menu.
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.
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.
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
options
Configures the DevExtreme UI component used as a toolbar item.
jQuery
$(function() { $("#popupContainer").dxPopup({ // ... toolbarItems: [{ 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-popup ... > <dxi-toolbar-item widget="dxCheckBox" [options]="{ text: 'Show IDs' }"> </dxi-toolbar-item> </dx-popup>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPopupModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPopupModule ], 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> <DxPopup> <DxToolbarItem ... widget="dxCheckBox" :options="checkBoxOptions" /> </DxPopup> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxPopup, { DxToolbarItem } from 'devextreme-vue/popup'; export default { components: { DxPopup, DxToolbarItem }, 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 Popup, { ToolbarItem } from 'devextreme-react/popup'; function App() { checkBoxOptions = { text: 'Show IDs' }; return ( <Popup ... > <ToolbarItem widget="dxCheckBox" options={this.checkBoxOptions} /> </Popup> ); } export default App;
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.
template
Specifies a template that should be used to render this item only.
The following types of the specified value are available.
- 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 Popup toolbar. Note that Angular and Vue use custom templates instead of the template property. In React, specify the render or component properties.
jQuery
$(function() { $("#popupContainer").dxPopup({ // ... toolbarItems: [ { // ... template: '<div>Custom Item</div>' } }] }); });
Angular
<dx-popup ... > <dxi-toolbar-item ...> <div *dxTemplate> <div>Custom Item</div> </div> </dxi-toolbar-item> </dx-popup>
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 { DxPopupModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPopupModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxPopup> <DxToolbarItem ...> <div>Custom Item</div> </DxToolbarItem> </DxPopup> </template> <script> import DxPopup, { DxToolbarItem } from 'devextreme-vue/popup'; export default { components: { DxPopup, DxToolbarItem }, // ... } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import Popup, { ToolbarItem } from 'devextreme-react/popup'; const renderCustomItem = () => { return <div>Custom Item</div>; } function App() { return ( <Popup ... > <ToolbarItem ... render={renderCustomItem} > </ToolbarItem> </Popup> ); } export default App;
toolbar
Specifies whether the item is displayed on a top or bottom toolbar.
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.