jQuery Popup - toolbarItems
In the following code, two items are defined on the toolbar: one is plain text, another is the Button UI component:
jQuery
index.js
index.html
$(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
app.component.html
app.component.ts
app.module.ts
<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
Index.cshtml
@(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
App.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
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;html
Type:
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.
options
Type: any
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
app.component.html
app.module.ts
<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
App.vue
<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
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;template
Type:
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.
widget
Type:
Accepted Values: 'dxAutocomplete' | 'dxButton' | 'dxCheckBox' | 'dxDateBox' | 'dxMenu' | 'dxSelectBox' | 'dxTabs' | 'dxTextBox' | 'dxButtonGroup' | 'dxDropDownButton'
Feedback