Vue Popup Props
An object defining configuration properties for the Popup UI component.
See Also
- Configure a Widget: Angular | Vue | React | jQuery | AngularJS | Knockout | ASP.NET MVC 5 | ASP.NET Core
accessKey
Specifies the shortcut key that sets focus on the UI component.
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
animation
Use the position property to specify the position in which the UI component is shown and from which it is hidden.
Set the animation object to null or undefined to disable animation.
closeOnOutsideClick
Specifies whether to close the UI component if a user clicks outside it.
Event (jQuery or EventObject)
The event that caused UI component closing. It is a dxEvent or a jQuery.Event when you use jQuery.
true if the UI component should be closed; otherwise false.
The function passed to this property enables you to specify a custom condition for UI component closing. For instance, you can prevent closing until a user clicks a certain element.
jQuery
$(function () { $("#popupContainer").dxPopup({ // ... closeOnOutsideClick: function(e) { return e.target === $("#someElement").get()[0]; } }); });
Angular
import { DxPopupModule } from "devextreme-angular"; // ... export class AppComponent { // ... closeOnOutsideClick(e) { return e.target === document.getElementById("someElement"); } } @NgModule({ imports: [ // ... DxPopupModule ], // ... })
<dx-popup ... [closeOnOutsideClick]="closeOnOutsideClick"> </dx-popup>
The closeOnOutsideClick function is called when a user clicks the UI component or outside it.
container
Specifies the container in which to render the UI component.
The default container is defined during the UI component's initialization. It is the viewport, the body element if the viewport is not found or the parent element if the previous two are absent.
The specified container affects some features of the Popup: the area to be shaded, behavior on scrolling, etc.
contentComponent
An alias for the contentTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
contentRender
An alias for the contentTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
deferRendering
Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.
disabled
Specifies whether the UI component responds to user interaction.
dragEnabled
Specifies whether or not to allow a user to drag the popup window.
A user can drag the popup window by the title. Therefore, this property makes sense if the showTitle property is set to true.
<html style="height: 100%;"> <head> . . . </head> <body style="min-height: 100%;"> . . . </body> </html>
elementAttr
Specifies the global attributes to be attached to the UI component's container element.
jQuery
$(function(){ $("#popupContainer").dxPopup({ // ... elementAttr: { id: "elementId", class: "class-name" } }); });
Angular
<dx-popup ... [elementAttr]="{ id: 'elementId', class: 'class-name' }"> </dx-popup>
import { DxPopupModule } from "devextreme-angular"; // ... export class AppComponent { // ... } @NgModule({ imports: [ // ... DxPopupModule ], // ... })
Vue
<template> <DxPopup ... :element-attr="popupAttributes"> </DxPopup> </template> <script> import DxPopup from 'devextreme-vue/popup'; export default { components: { DxPopup }, data() { return { popupAttributes: { id: 'elementId', class: 'class-name' } } } } </script>
React
import React from 'react'; import Popup from 'devextreme-react/popup'; class App extends React.Component { popupAttributes = { id: 'elementId', class: 'class-name' } render() { return ( <Popup ... elementAttr={this.popupAttributes}> </Popup> ); } } export default App;
focusStateEnabled
Specifies whether the UI component can be focused using keyboard navigation.
fullScreen
Specifies whether to display the Popup in full-screen mode.
height
Specifies the UI component's height in pixels.
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
hint
Specifies text for a hint that appears when a user pauses on the UI component.
hoverStateEnabled
Specifies whether the UI component changes its state when a user pauses on it.
maxHeight
Specifies the maximum height the UI component can reach while resizing.
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
maxWidth
Specifies the maximum width the UI component can reach while resizing.
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
minHeight
Specifies the minimum height the UI component can reach while resizing.
This property accepts a value of one of the following types:
Number
The height in pixels.String
A CSS-accepted measurement of height. For example,"55px"
,"80%"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptheight: function() { return window.innerHeight / 1.5; }
minWidth
Specifies the minimum width the UI component can reach while resizing.
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
onContentReady
A function that is executed when the UI component's content is ready and each time the content is changed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only when using Knockout. |
onDisposing
A function that is executed before the UI component is disposed of.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if you use Knockout. |
onHidden
A function that is executed after the UI component is hidden.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onHiding
A function that is executed before the UI component is hidden.
Information about the event.
Name | Type | Description |
---|---|---|
cancel |
Allows you to cancel overlay hiding. |
|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onInitialized
A function used in JavaScript frameworks to save the UI component instance.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
onOptionChanged
A function that is executed after a UI component property is changed.
Information about the event.
Name | Type | Description |
---|---|---|
model |
Model data. Available only if you use Knockout. |
|
fullName |
The path to the modified property that includes all parent properties. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
component |
The UI component's instance. |
|
name |
The modified property if it belongs to the first level. Otherwise, the first-level property it is nested into. |
|
value | any |
The modified property's new value. |
The following example shows how to subscribe to component property changes:
jQuery
$(function() { $("#popupContainer").dxPopup({ // ... onOptionChanged: function(e) { if(e.name === "changedProperty") { // handle the property change here } } }); });
Angular
<dx-popup ... (onOptionChanged)="handlePropertyChange($event)"> </dx-popup>
import { Component } from '@angular/core'; @Component({ selector: 'app-root', templateUrl: './app.component.html', styleUrls: ['./app.component.css'] }) export class AppComponent { // ... handlePropertyChange(e) { if(e.name === "changedProperty") { // handle the property change here } } }
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 ... @option-changed="handlePropertyChange" /> </template> <script> import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import DxPopup from 'devextreme-vue/popup'; export default { components: { DxPopup }, // ... methods: { handlePropertyChange: function(e) { if(e.name === "changedProperty") { // handle the property change here } } } } </script>
React
import React from 'react'; import 'devextreme/dist/css/dx.common.css'; import 'devextreme/dist/css/dx.light.css'; import Popup from 'devextreme-react/popup'; const handlePropertyChange = (e) => { if(e.name === "changedProperty") { // handle the property change here } } export default function App() { return ( <Popup ... onOptionChanged={handlePropertyChange} /> ); }
onResize
A function that is executed each time the UI component is resized by one pixel.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onResizeEnd
A function that is executed when resizing ends.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onResizeStart
A function that is executed when resizing starts.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onShowing
A function that is executed before the UI component is displayed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onShown
A function that is executed after the UI component is displayed.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
onTitleRendered
A function that is executed when the UI component's title is rendered.
Information about the event.
Name | Type | Description |
---|---|---|
component |
The UI component's instance. |
|
element |
The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery. |
|
model |
Model data. Available only if Knockout is used. |
|
titleElement |
The title's container. It is an HTML Element or a jQuery Element when you use jQuery. |
position
Positions the UI component.
This property accepts one of the following:
Position configuration object
An object that specifies the UI component's position.String
A shortcut listed in the accepted values. Positions the UI component relative to the window.Function
A function that returns one of the above. Use it to position the UI component based on a condition.
resizeEnabled
Specifies whether or not an end user can resize the UI component.
rtlEnabled
Switches the UI component to a right-to-left representation.
When this property is set to true, the UI component text flows from right to left, and the layout of elements is reversed. To switch the entire application/site to the right-to-left representation, assign true to the rtlEnabled field of the object passed to the DevExpress.config(config) method.
DevExpress.config({ rtlEnabled: true });
See Also
- Right-to-Left Support Demo: DataGrid | Navigation Widgets | Editors
shading
Specifies whether to shade the background when the UI component is active.
shadingColor
Specifies the shading color. Applies only if shading is enabled.
This property supports the following colors:
- Hexadecimal colors
- RGB colors
- RGBA colors
- Predefined/cross-browser color names
- Predefined SVG colors
- Paint server address
showCloseButton
Specifies whether or not the UI component displays the Close button.
showTitle
A Boolean value specifying whether or not to display the title in the popup window.
tabIndex
Specifies the number of the element when the Tab key is used for navigating.
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
title
The title in the overlay window.
titleComponent
An alias for the titleTemplate property specified in React. Accepts a custom component. Refer to Using a Custom Component for more information.
titleRender
An alias for the titleTemplate property specified in React. Accepts a rendering function. Refer to Using a Rendering Function for more information.
titleTemplate
Specifies a custom template for the UI component title. Does not apply if the title is defined.
See Also
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.common.css'; 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.common.css'; 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;
width
Specifies the UI component's width in pixels.
This property accepts a value of one of the following types:
Number
The width in pixels.String
A CSS-accepted measurement of width. For example,"55px"
,"80%"
,"auto"
,"inherit"
.Function
A function returning either of the above. For example:JavaScriptwidth: function() { return window.innerWidth / 1.5; }
If you have technical questions, please create a support ticket in the DevExpress Support Center.