JavaScript/jQuery Popup Options

See Also

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

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

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

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):

• color swatch container

• .dx-viewport

• body

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

Popup Demo

See Also

• Customize the Content
• Custom Templates

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:

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

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

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.

<html style="height: 100%;">
    <head>
    . . .
    </head>
    <body style="min-height: 100%;">
    . . .
    </body>
</html>

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

Disable this property to hide the body scrollbar and prevent scrolling of the page.

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.

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.

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

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>

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

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

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.

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.

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.

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.

See Also

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

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

<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 { }  

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

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

View on GitHub

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

• restorePostion

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

DataGrid Demo Navigation UI Demo Editors Demo

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.

This property supports the following colors:

• Hexadecimal colors
• RGB colors
• RGBA colors
• Predefined/cross-browser color names
• Predefined SVG colors
• Paint server address

View Demo

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

View Demo

See Also

• Customize the Title
• Custom Templates

In the following code, two items are defined on the toolbar: one is plain text, another is the Button UI component:

$(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>

<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 { }

@(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>

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

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

Popup Demo

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.

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

<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 { }

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

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:

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

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

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

<Popup ... className="myClass" />

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

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