JavaScript/jQuery Popup Options
accessKey
The value of this property will be passed to the accesskey
attribute of the HTML element that underlies the UI component.
animation
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.
closeOnOutsideClick
Use the hideOnOutsideClick property instead.
Event (jQuery or EventObject)
The event that caused UI component closing. It is a EventObject or a jQuery.Event when you use jQuery.
container
This property accepts one of the following values:
A CSS selector, or a jQuery selector if you use jQuery
index.js- $(function(){
- $("#popupContainer").dxPopup({
- // ...
- container: '#containerElement'
- });
- });
A jQuery wrapper
index.js- $(function(){
- $("#popupContainer").dxPopup({
- // ...
- container: $('#containerElement')
- });
- });
A DOM element
index.js- $(function(){
- $("#popupContainer").dxPopup({
- // ...
- container: document.getElementById('#containerElement')
- });
- });
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):
.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.
copyRootClassesToWrapper
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>
deferRendering
Specifies whether to render the UI component's content when it is displayed. If false, the content is rendered immediately.
dragAndResizeArea
Specifies an element with boundaries within which users can drag and resize the Popup. Ignored if the dragOutsideBoundary property is set to true.
If you leave this property unspecified, users can drag and resize the Popup within boundaries of the element defined by the container property.
dragEnabled
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>
dragOutsideBoundary
When you set this property to true, drag area boundaries defined by dragAndResizeArea and container properties are ignored.
fullScreen
height
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
Event (jQuery or EventObject)
The event that caused UI component hiding. It is a EventObject or a jQuery.Event when you use jQuery.
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];
- }
- });
- });
The hideOnOutsideClick function is called when a user clicks the UI component or outside it.
maxHeight
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
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
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
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.
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. |
onDisposing
A function that is executed before the UI component is disposed of.
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. |
onHidden
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. |
onHiding
Name | Type | Description |
---|---|---|
cancel | | |
Set this field to true if you want the Popup to remain visible. |
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 | any |
Model data. Available only if Knockout is used. |
onInitialized
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
Name | Type | Description |
---|---|---|
model | any |
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. |
previousValue | any |
The UI component's previous value. |
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
- }
- }
- });
- });
onResize
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 | 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 |
The UI component's height after resize. |
|
width |
The UI component's width after resize. |
onResizeEnd
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 | 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 |
The UI component's height after resize. |
|
width |
The UI component's width after resize. |
onResizeStart
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 | 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 |
The UI component's height before resize. |
|
width |
The UI component's width before resize. |
onShowing
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 | any |
Model data. Available only if Knockout is used. |
cancel | | |
Set this field to true if you want to prevent the Popup from being displayed. |
onShown
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. |
onTitleRendered
A function that is executed when the UI component's title is rendered.
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 | any |
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
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.
See Also
restorePosition
Specifies whether to display the Popup at the initial position when users reopen it.
rtlEnabled
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
- });
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
tabIndex
The value of this property will be passed to the tabindex
attribute of the HTML element that underlies the UI component.
titleTemplate
Specifies a custom template for the UI component title. Does not apply if the title is defined.
toolbarItems[]
In the following code, two items are defined on the toolbar: one is plain text, another is the Button UI component:
width
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.
- $(function(){
- $("#popupContainer").dxPopup({
- // ...
- wrapperAttr: {
- id: "elementId",
- class: "class-name"
- }
- });
- });
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>