React Popup Props

An object defining configuration properties for the Popup UI component.

accessKey

Specifies the shortcut key that sets focus on the UI component.

Type:

String

Default Value: undefined

The value of this property will be passed to the accesskey attribute of the HTML element that underlies the UI component.

animation

Configures UI component visibility animations. This object contains two fields: show and hide.

Selector: Animation
Type:

Object

The following code shows default values of the object depending on the device type:

Desktop
iOS
Android
Android FullScreen
{
    show: {
        type: 'pop',
        duration: 300,
        from: {
            scale: 0.55
        }
    },
    hide: {
        type: 'pop',
        duration: 300,
        to: {
            opacity: 0,
            scale: 0.55
        },
        from: {
            opacity: 1,
            scale: 1
        }
    }
}
{
    show: {
        type: 'slide',
        duration: 400,
        from: {
            position: {
                my: 'top',
                at: 'bottom'
            }
        },
        to: {
            position: {
                my: 'center',
                at: 'center'
            }   
        }
    },
    hide: {
        type: 'slide',
        duration: 400,
        from: {
            opacity: 1,
            position: {
                my: 'center',
                at: 'center'
            }
        },
        to: {
            opacity: 1,
            position: {
                my: 'top',
                at: 'bottom'
            }
        }
    }
}
{
    show: {
        type: 'fade',
        duration: 400,
        from: 0,
        to: 1
    },
    hide: {
        type: 'fade',
        duration: 400,
        from: 1,
        to: 0
    }   
}
{
    show: {
        type: 'slide',
        duration: 300,
        from: {
            top: '30%',
            opacity: 0
        },
        to: {
            top: 0,
            opacity: 1
        }
    },
    hide: {
        type: 'slide',
        duration: 300,
        from: {
            top: 0,
            opacity: 1
        },
        to: {
            top: '30%',
            opacity: 0
        }
    }
}

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

closeOnOutsideClick Deprecated

Use the hideOnOutsideClick property instead.

Specifies whether to close the UI component if a user clicks outside it.

Type:

Boolean

|

Function

Function parameters:
event:

Event (jQuery or EventObject)

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

Return Value:

Boolean

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

Default Value: false

container

Specifies the container in which to render the UI component.

Default Value: undefined

This property accepts one of the following values:

  • A CSS selector, or a jQuery selector if you use jQuery

    jQuery
    index.js
    $(function(){
        $("#popupContainer").dxPopup({
            // ...
            container: '#containerElement'
        });
    });
    Angular
    app.component.html
    <dx-popup ... 
        container="#containerElement"
    >
    </dx-popup>
    Vue
    App.vue
    <template>
        <DxPopup ... 
            container="#containerElement"
        >
        </DxPopup>
    </template>
    <script>
    import { DxPopup } from 'devextreme-vue/popup';
    
    export default {
        components: {
            DxPopup
        }
    };
    </script>
    React
    App.js
    import Popup from 'devextreme-react/popup';
    // ...
    function App() {
        return (
            <Popup ... 
                container="#containerElement"
            >
            </Popup>
        );
    }
  • A jQuery wrapper

    jQuery
    index.js
    $(function(){
        $("#popupContainer").dxPopup({
            // ...
            container: $('#containerElement')
        });
    });
  • A DOM element

    jQuery
    index.js
    $(function(){
        $("#popupContainer").dxPopup({
            // ...
            container: document.getElementById('#containerElement')
        });
    });
    Angular
    app.component.html
    app.component.ts
    <dx-popup ... 
        [container]="containerElement"
    >
    </dx-popup>
    // ...
    export class AppComponent {
        containerElement: Element;
        constructor() {
            this.containerElement = document.getElementById('#containerElement') as Element;
        }
    }
    Vue
    App.vue
    <template>
        <DxPopup ... 
            :container="containerElement"
        >
        </DxPopup>
    </template>
    <script>
    import { DxPopup } from 'devextreme-vue/popup';
    
    export default {
        components: {
            DxPopup
        },
        data() {
            return {
                containerElement: null
            }
        },
        mounted() {
            this.containerElement = document.getElementById('containerElement');
        }
    };
    </script>
    React
    App.js
    import React, { useEffect, useState } from 'react';
    import Popup from 'devextreme-react/popup';
    // ...
    function App() {
        const [containerElement, setContainerElement] = useState(null);
        useEffect(() => {
            setContainerElement(document.getElementById('containerElement'));
        }, []);
        return (
            <Popup ... 
                container={containerElement}
            >
            </Popup>
        );
    }

The UI component defines the default container on its initialization. This default container can be one of the following (if the element is absent, the component selects the next one):

If you set this property to a specific element, the shading applies to this element. The Popup calculates its size relative to the element.

Popup Demo

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'

copyRootClassesToWrapper Deprecated

IMPORTANT
Use the wrapperAttr property instead.

Copies your custom CSS classes from the root element to the wrapper element.

Type:

Boolean

Default Value: false

This property allows you to use CSS for wrapper element configuration. You can customize the shade, resize, and drag zones.

The following markup illustrates relations between wrapper and root elements when you set copyRootClassesToWrapper to true:

HTML
<body>

    <!-- The following element is the root element on which the component is initialized. -->
    <!-- Specify classes to be copied to the wrapper element here. -->
    <div id="popup" class="custom-class" ... ></div>

    <!-- The following element is the wrapper element. -->
    <!-- Custom classes are automatically copied from the root element. -->
    <div class="dx-overlay-wrapper dx-popup-wrapper custom-class" ... > 

        <!-- The following element contains toolbars and component content. -->
        <div class="dx-popup-content" ... >
            <!-- ... -->
        </div>
    </div>
</body>

deferRendering

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

Type:

Boolean

Default Value: true

Angular

If you set the deferRendering property to true, wrap the content in the Angular named template.

Vue

If you set the deferRendering property to true, wrap the content in the Vue named template.

disabled

Specifies whether the UI component responds to user interaction.

Type:

Boolean

Default Value: false

dragAndResizeArea

Specifies an element with boundaries within which users can drag and resize the Popup. Ignored if the dragOutsideBoundary property is set to true.

Default Value: undefined

If you leave this property unspecified, users can drag and resize the Popup within boundaries of the element defined by the container property.

dragEnabled

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

Type:

Boolean

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.

You can set the restorePosition property to false if you want to display the Popup at the same position to which users dragged it.

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>

dragOutsideBoundary

Allows users to drag the Popup within the browser window or beyond the window's borders.

Type:

Boolean

Default Value: false

When you set this property to true, drag area boundaries defined by dragAndResizeArea and container properties are ignored.

elementAttr Deprecated

Use the wrapperAttr property instead.

Specifies the global attributes to be attached to the UI component's container element.

Type: any
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:

Boolean

Default Value: true (desktop)

fullScreen

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

Type:

Boolean

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.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's height.

Default Value: '80vh'
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", "20vh", "80%", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

The Popup calculates its height relative to one of the elements in the following priority: container => position.of => window.

hideOnOutsideClick

Specifies whether to hide the UI component if a user clicks outside it.

Type:

Boolean

|

Function

Function parameters:
event:

Event (jQuery or EventObject)

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

Return Value:

Boolean

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

Default Value: false

The function passed to this property enables you to specify a custom condition for UI component hiding. For instance, you can prevent hiding until a user clicks a certain element.

jQuery
JavaScript
$(function () {
    $("#popupContainer").dxPopup({
        // ...
        hideOnOutsideClick: function(e) {
            return e.target === $("#someElement").get()[0];
        }
    });
});
Angular
TypeScript
HTML
import { DxPopupModule } from "devextreme-angular";
// ...
export class AppComponent {
    // ...
    hideOnOutsideClick(e) {
        return e.target === document.getElementById("someElement");
    }
}
@NgModule({
     imports: [
         // ...
         DxPopupModule
     ],
     // ...
 })
<dx-popup ...
    [hideOnOutsideClick]="hideOnOutsideClick">
</dx-popup>
Vue
App.vue
<template>
    <DxPopup ....
        :hide-on-outside-click="hideOnOutsideClick">
    </DxPopup>
</template>

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

import DxPopup from 'devextreme-vue/popup';

export default {
    components: {
        DxPopup
    },
    methods: {
        hideOnOutsideClick (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 hideOnOutsideClick = (e) => {
    return e.target === document.getElementById("someElement");
};

export default function App() {
    return (
        <Popup ...
            hideOnOutsideClick={hideOnOutsideClick}>
        </Popup>
    );
}

The hideOnOutsideClick function is called when a user clicks the UI component or outside it.

Popup Demo

hideOnParentScroll

Specifies whether to hide the Popup when users scroll one of its parent elements.

Type:

Boolean

Default Value: false

hint

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

Type:

String

Default Value: undefined

hoverStateEnabled

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

Type:

Boolean

Default Value: false

maxHeight

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

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

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", "20vh", "80%", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

maxWidth

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

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

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", "20vw", "80%", "auto", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

minHeight

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

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

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", "20vh", "80%", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

minWidth

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

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

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", "20vw", "80%", "auto", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

onContentReady

A function that is executed when the UI component is rendered and each time the component is repainted.

Type:

Function

Function parameters:
e:

Object

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 any

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

Function parameters:
e:

Object

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 any

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

Function parameters:
e:

Object

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 any

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

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
cancel

Boolean

|

Promise<Boolean> (jQuery or native)

Set this field to true if you want the Popup to remain visible.

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 any

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

Function parameters:
e:

Object

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.

Default Value: null

onOptionChanged

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

Type:

Function

Function parameters:
e:

Object

Information about the event.

Object structure:
Name Type Description
model any

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.

previousValue any

The UI component's previous 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.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.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

Function parameters:
e:

Object

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 any

Model data. Available only if Knockout is used.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

height

Number

The UI component's height after resize.

width

Number

The UI component's width after resize.

Default Value: null

onResizeEnd

A function that is executed when resizing ends.

Type:

Function

Function parameters:
e:

Object

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 any

Model data. Available only if Knockout is used.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

height

Number

The UI component's height after resize.

width

Number

The UI component's width after resize.

Default Value: null

onResizeStart

A function that is executed when resizing starts.

Type:

Function

Function parameters:
e:

Object

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 any

Model data. Available only if Knockout is used.

event

Event (jQuery or EventObject)

The event that caused the function to execute. It is an EventObject or a jQuery.Event when you use jQuery.

height

Number

The UI component's height before resize.

width

Number

The UI component's width before resize.

Default Value: null

onShowing

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

Type:

Function

Function parameters:
e:

Object

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 any

Model data. Available only if Knockout is used.

cancel

Boolean

|

Promise<Boolean> (jQuery or native)

Set this field to true if you want to prevent the Popup from being displayed.

Default Value: null

onShown

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

Type:

Function

Function parameters:
e:

Object

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 any

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

Function parameters:
e:

Object

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 any

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.

Selector: Position
Default Value: { my: 'center', at: 'center', of: window }
Accepted Values: 'bottom' | 'center' | 'left' | 'left bottom' | 'left top' | 'right' | 'right bottom' | 'right top' | 'top'
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 (deprecated since v21.2)
    Refer to the W0018 warning description for information on how to migrate to other property values.

If you do not specify the container property and set the position.of to a specific element, the shading applies to this element. The Popup calculates its size relative to the element.

Popup Demo

See Also

resizeEnabled

Specifies whether or not an end user can resize the UI component.

Type:

Boolean

Default Value: false

restorePosition

Specifies whether to display the Popup at the initial position when users reopen it.

Type:

Boolean

Default Value: true

rtlEnabled

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

Type:

Boolean

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
});

DataGrid Demo Navigation UI Demo Editors Demo

shading

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

Type:

Boolean

Default Value: true

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

If this property is set to true, the Popup is displayed in modal mode, and users cannot interact with other UI components.

shadingColor

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

Type:

String

Default Value: ''

This property supports the following colors:

showCloseButton

Specifies whether or not the UI component displays the Close button.

Type:

Boolean

Default Value: false, false (Material), 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:

Boolean

Default Value: true

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:

String

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.

Selector: ToolbarItem

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;

Popup Demo

visible

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

Type:

Boolean

Default Value: false
Raised Events: onHiding onShowing

width

Specifies the UI component's width.

Type:

Number

|

String

|

Function

Return Value:

Number

|

String

The UI component's width.

Default Value: '80vw'
Raised Events: onResize

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", "20vw", "80%", "auto", "inherit".

  • Function (deprecated since v21.2)
    Refer to the W0017 warning description for information on how you can migrate to viewport units.

The Popup calculates its width relative to one of the elements in the following priority: container => position.of => window.

wrapperAttr

Specifies the global attributes for the UI component's wrapper element.

Type: any
Default Value: {}

jQuery
$(function(){
    $("#popupContainer").dxPopup({
        // ...
        wrapperAttr: {
            id: "elementId",
            class: "class-name"
        }
    });
});
Angular
app.component.html
app.component.ts
app.module.ts
<dx-popup ...
    [wrapperAttr]="{ id: 'elementId', class: 'class-name' }">
</dx-popup>
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 { DxPopupModule } from 'devextreme-angular';

@NgModule({
    declarations: [
        AppComponent
    ],
    imports: [
        BrowserModule,
        DxPopupModule
    ],
    providers: [ ],
    bootstrap: [AppComponent]
})
export class AppModule { }
Vue
App.vue
<template>
    <DxPopup ...
        :wrapper-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, { useMemo } from 'react';

import Popup from 'devextreme-react/popup';

function App() {
    const popupAttributes = useMemo(() => {
        return {
            id: 'elementId',
            class: 'class-name'
        }
    }, []);

    return (
        <Popup ...
            wrapperAttr={popupAttributes}>
        </Popup>
    );
}
export default App;

The code above specifies the id and class attributes for the wrapper element and produces markup similar to this:

HTML
<body>
    <!-- The following is the wrapper element. -->
    <!-- It is nested inside an element defined by the `container` property (`<body>` by default). -->
    <div id="elementId" class="dx-overlay-wrapper dx-popup-wrapper class-name" ... > 

        <!-- The following element contains toolbars and component content. -->
        <div class="dx-overlay-content">

            <!-- The following element displays content specified in the `contentTemplate`. -->
            <div class="dx-popup-content" ... >
                <!-- ... -->
            </div>
        </div>
    </div>
</body>
jQuery

You can specify attributes to the component's root element directly in HTML code:

<div id="myPopup" class="myClass"></div>
Angular

You can specify attributes to the component's root element directly in HTML code:

<dx-popup ... class="myClass">
</dx-popup>
React

You can specify attributes to the component's root element directly in HTML code:

<Popup ... className="myClass" />
ASP.NET Core Controls

To add an attribute to an ASP.NET Core control, use its OnInitialized method:

@(Html.DevExtreme().Popup()...
    .OnInitialized("(e) => e.element.addClass('myClass')")
)
ASP.NET MVC Controls

To add an attribute to an ASP.NET MVC control, use its OnInitialized method:

    @(Html.DevExtreme().Popup()...
    .OnInitialized("(e) => e.element.addClass('myClass')")
)