React Popup - toolbarItems

Configures toolbar items.

Selector: ToolbarItem
Type:

Array<Object>

In the following code, two items are defined on the toolbar: one is plain text, another is the Button UI component:

App.js
  • 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;

Popup Demo

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 toolbar item responds to user interaction.

Type:

Boolean

Default Value: false

html

Specifies the HTML markup to be inserted into the toolbar item element.

Type:

String

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.

location

Specifies a location for the item on the toolbar.

Type:

String

Default Value: 'center'
Accepted Values: 'after' | 'before' | 'center'

options

Configures the DevExtreme UI component used as a toolbar item.

Type: any

Popup Demo

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.

App.js
  • import React from 'react';
  •  
  • import 'devextreme/dist/css/dx.light.css';
  •  
  • import Popup, {
  • ToolbarItem
  • } from 'devextreme-react/popup';
  •  
  • class App extends React.Component {
  • checkBoxOptions = { text: 'Show IDs' };
  •  
  • render() {
  • 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.

template

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

Type:

template

Template Data: undefined

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.
NOTE
The dxTemplate component can not be used as a toolbarItems template.

text

Specifies text displayed for the toolbar item.

Type:

String

toolbar

Specifies whether the item is displayed on a top or bottom toolbar.

Type:

String

Default Value: 'top'
Accepted Values: 'bottom' | 'top'

visible

Specifies whether or not a UI component item must be displayed.

Type:

Boolean

Default Value: true

widget

A UI component that presents a toolbar item.

Type:

String

Accepted Values: 'dxAutocomplete' | 'dxButton' | 'dxCheckBox' | 'dxDateBox' | 'dxMenu' | 'dxSelectBox' | 'dxTabs' | 'dxTextBox' | 'dxButtonGroup' | 'dxDropDownButton'

NOTE
Import the specified UI component's module when using DevExtreme modules.

Popup Demo