Vue Popover - toolbarItems
In the following code, two items are defined on the toolbar: one is plain text, another is the Button UI component:
jQuery
$(function() { $("#popoverContainer").dxPopover({ // ... toolbarItems: [{ text: "Title", location: "before" }, { widget: "dxButton", location: "after", options: { text: "Refresh", onClick: function(e) { /* ... */ } } }] }); });
<div id="popoverContainer"> <p>Popover content</p> </div>
Angular
<dx-popover ... > <div *dxTemplate="let data of 'content'"> <p>Popover content</p> </div> <dxi-popup-toolbar-item text="Title" location="before"> </dxi-popup-toolbar-item> <dxi-popup-toolbar-item widget="dxButton" location="after" [options]="{ text: 'Refresh', onClick: refresh }"> </dxi-popup-toolbar-item> </dx-popover>
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 { DxPopoverModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPopoverModule ], providers: [], bootstrap: [AppComponent] }) export class AppModule { }
ASP.NET MVC Controls
@(Html.DevExtreme().Popover() <!-- ... --> .ContentTemplate(@<text> <p>Popover 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> <DxPopover ... > <p>Popover content</p> <DxToolbarItem text="Title" location="before"> </DxToolbarItem> <DxToolbarItem widget="dxButton" :options="buttonOptions" location="after"> </DxToolbarItem> </DxPopover> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxPopover, { DxToolbarItem } from 'devextreme-vue/popover'; export default { components: { DxPopover }, data() { return { buttonOptions: { text: 'Refresh', onClick: function(e) { /* ... */ } } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import { Popover, ToolbarItem } from 'devextreme-react/popover'; class App extends React.Component { constructor() { this.buttonOptions = { text: 'Refresh', onClick: function(e) { /* ... */ } }; } render() { return ( <Popover ... > <p>Popover Content</p> <ToolbarItem text="Title" location="before"> </ToolbarItem> <ToolbarItem widget="dxButton" location="after" options={this.buttonOptions}> </ToolbarItem> </Popover> ); } } export default App;
html
The Popover component evaluates the html property's value. This evaluation, however, makes the Popover 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
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
options
jQuery
$(function() { $("#popoverContainer").dxPopover({ // ... 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-popover ... > <dxi-popup-toolbar-item widget="dxCheckBox" [options]="{ text: 'Show IDs' }"> </dxi-popup-toolbar-item> </dx-popover>
import { BrowserModule } from '@angular/platform-browser'; import { NgModule } from '@angular/core'; import { AppComponent } from './app.component'; import { DxPopoverModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPopoverModule ], 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> <DxPopover> <DxToolbarItem ... widget="dxCheckBox" :options="checkBoxOptions" /> </DxPopover> </template> <script> import 'devextreme/dist/css/dx.light.css'; import DxPopover, { DxToolbarItem } from 'devextreme-vue/popover'; export default { components: { DxPopover, 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 Popover, { ToolbarItem } from 'devextreme-react/popover'; function App() { checkBoxOptions = { text: 'Show IDs' }; return ( <Popover ... > <ToolbarItem widget="dxCheckBox" options={this.checkBoxOptions} /> </Popover> ); } export default App;
template
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() { $("#popoverContainer").dxPopover({ // ... toolbarItems: [ { // ... template: '<div>Custom Item</div>' } }] }); });
Angular
<dx-popover ... > <dxi-popup-toolbar-item ...> <div *dxTemplate> <div>Custom Item</div> </div> </dxi-popup-toolbar-item> </dx-popover>
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 { DxPopoverModule } from 'devextreme-angular'; @NgModule({ declarations: [ AppComponent ], imports: [ BrowserModule, DxPopoverModule ], providers: [ ], bootstrap: [AppComponent] }) export class AppModule { }
Vue
<template> <DxPopover> <DxToolbarItem ...> <div>Custom Item</div> </DxToolbarItem> </DxPopover> </template> <script> import DxPopover, { DxToolbarItem } from 'devextreme-vue/popover'; export default { components: { DxPopover, DxToolbarItem }, // ... } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.light.css'; import Popover, { ToolbarItem } from 'devextreme-react/popover'; const renderCustomItem = () => { return <div>Custom Item</div>; } function App() { return ( <Popover ... > <ToolbarItem ... render={renderCustomItem} > </ToolbarItem> </Popover> ); } export default App;
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.