Vue Popup Props

Default Value: { show: { type: 'slide', duration: 400, from: { position: { my: 'top', at: 'bottom', of: window } }, to: { position: { my: 'center', at: 'center', of: window } } }, hide: { type: 'slide', duration: 400, from: { position: { my: 'center', at: 'center', of: window } }, to: { position: { my: 'top', at: 'bottom', of: window } } }} (iOS)

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.

Type:

|

Function parameters:

event:

Event (jQuery or EventObject)

The event that caused UI component closing. It is a dxEvent or a jQuery.Event when you use jQuery.

Return Value:

true if the UI component should be closed; otherwise false.

Default Value: 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

JavaScript

$(function () {
    $("#popupContainer").dxPopup({
        // ...
        closeOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});

Angular

TypeScript

HTML

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>

Vue

App.vue

<template>
    <DxPopup ....
        :close-on-outside-click="closeOnOutsideClick">
    </DxPopup>
</template>

<script>
import 'devextreme/dist/css/dx.light.css';

import DxPopup from 'devextreme-vue/popup';

export default {
    components: {
        DxPopup
    },
    methods: {
        closeOnOutsideClick (e) {
            return e.target === document.getElementById("someElement");
        }
    }
}
</script>

React

App.js

import React from 'react';
import 'devextreme/dist/css/dx.light.css';

import Popup from 'devextreme-react/popup';

const closeOnOutsideClick = (e) => {
    return e.target === document.getElementById("someElement");
};

export default function App() {
    return (
        <Popup ...
            closeOnOutsideClick={closeOnOutsideClick}>
        </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.

Type:

|

Element

|

jQuery

Default Value: undefined

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.

contentTemplate

Specifies a custom template for the UI component content.

Type:

template

Template Data: undefined

Default Name: 'content'

deferRendering

Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.

Type:

Default Value: true

disabled

Specifies whether the UI component responds to user interaction.

Type:

Default Value: false

dragEnabled

Specifies whether or not to allow a user to drag the popup window.

Type:

Default Value: false, true (desktop)

A user can drag the popup window by the title. Therefore, this property makes sense if the showTitle property is set to true.

NOTE

Dragging is possible only if the "height: 100%" style setting is applied to the html element and "min-height: 100%" - to the body element.

HTML

<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.

Type:

Default Value: {}

jQuery

$(function(){
    $("#popupContainer").dxPopup({
        // ...
        elementAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});

Angular

HTML

TypeScript

<dx-popup ...
    [elementAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-popup>

import { DxPopupModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
}
@NgModule({
    imports: [
        // ...
        DxPopupModule
    ],
    // ...
})

Vue

App.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

App.js

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.

Type:

Default Value: true (desktop)

fullScreen

Specifies whether to display the Popup in full-screen mode.

Type:

Default Value: false

NOTE

When fullScreen is true, the UI component always occupies the entire screen and disregards the container value.

height

Specifies the UI component's height in pixels.

Type:

|

|

Return Value:

|

The UI component's height.

Default Value: function() { return $(window).height() * 0.8 }

Raised Events: onResize

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:
JavaScript
```
height: function() {
    return window.innerHeight / 1.5;
}
```

hint

Specifies text for a hint that appears when a user pauses on the UI component.

Type:

Default Value: undefined

hoverStateEnabled

Specifies whether the UI component changes its state when a user pauses on it.

Type:

Default Value: false

maxHeight

Specifies the maximum height the UI component can reach while resizing.

Type:

|

|

Return Value:

|

The maximum height.

Default Value: null

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:
JavaScript
```
height: function() {
    return window.innerHeight / 1.5;
}
```

maxWidth

Specifies the maximum width the UI component can reach while resizing.

Type:

|

|

Return Value:

|

The maximum width.

Default Value: null

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:
JavaScript
```
width: function() {
    return window.innerWidth / 1.5;
}
```

minHeight

Specifies the minimum height the UI component can reach while resizing.

Type:

|

|

Return Value:

|

The minimum height.

Default Value: null

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:
JavaScript
```
height: function() {
    return window.innerHeight / 1.5;
}
```

minWidth

Specifies the minimum width the UI component can reach while resizing.

Type:

|

|

Return Value:

|

The minimum width.

Default Value: null

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:
JavaScript
```
width: 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.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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.

Default Value: null

onDisposing

A function that is executed before the UI component is disposed of.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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.

Default Value: null

onHidden

A function that is executed after the UI component is hidden.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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.

Default Value: null

onHiding

A function that is executed before the UI component is hidden.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
cancel	Boolean	Allows you to cancel overlay hiding.
component	Popup	The UI component's instance.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	Model data. Available only if Knockout is used.

Default Value: null

onInitialized

A function used in JavaScript frameworks to save the UI component instance.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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.

Default Value: null

onOptionChanged

A function that is executed after a UI component property is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
model	Object	Model data. Available only if you use Knockout.
fullName	String	The path to the modified property that includes all parent properties.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Popup	The UI component's instance.
name	String	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.

Default Value: null

The following example shows how to subscribe to component property changes:

jQuery

index.js

$(function() {
    $("#popupContainer").dxPopup({
        // ...
        onOptionChanged: function(e) {
            if(e.name === "changedProperty") {
                // handle the property change here
            }
        }
    });
});

Angular

app.component.html

app.component.ts

app.module.ts

<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

App.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

App.js

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.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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.

Default Value: null

onResizeEnd

A function that is executed when resizing ends.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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.

Default Value: null

onResizeStart

A function that is executed when resizing starts.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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.

Default Value: null

onShowing

A function that is executed before the UI component is displayed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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.

Default Value: null

onShown

A function that is executed after the UI component is displayed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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.

Default Value: null

onTitleRendered

A function that is executed when the UI component's title is rendered.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Popup	The UI component's instance.
element	HTMLElement \| jQuery	The UI component's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	Model data. Available only if Knockout is used.
titleElement	HTMLElement \| jQuery	The title's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

position

Positions the UI component.

Type:

|

PositionConfig

|

Default Value: { my: 'center', at: 'center', of: window }

Raised Events: onPositioned

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.

Type:

Default Value: false

rtlEnabled

Switches the UI component to a right-to-left representation.

Type:

DataGrid Demo Navigation UI Demo Editors Demo

Default Value: false

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.

JavaScript

DevExpress.config({
    rtlEnabled: true
});

shading

Specifies whether to shade the background when the UI component is active.

Type:

Default Value: true

Shading applies to the first specified element in the following sequence: container => position.of => window

shadingColor

Specifies the shading color. Applies only if shading is enabled.

Type:

Default Value: ''

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.

Type:

Default Value: false, true (desktop)

NOTE

The property makes sense only if the showTitle property is set to true.

showTitle

A Boolean value specifying whether or not to display the title in the popup window.

Type:

Default Value: true

View Demo

tabIndex

Specifies the number of the element when the Tab key is used for navigating.

Type:

Number

Default Value: 0

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.

Type:

Default Value: ''

View Demo

NOTE

If the title property is specified, the titleTemplate property value is ignored.

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.

Type:

template

Template Data: undefined

Default Name: 'title'

toolbarItems[]

Configures toolbar items.

Type:

Array<Object>

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.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

App.js

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;

visible

A Boolean value specifying whether or not the UI component is visible.

Type:

Default Value: false

Raised Events: onShowing onHiding