JavaScript/jQuery Popup Options

Default Value: null

The value of this option will be passed to the accesskey attribute of the HTML element that underlies the widget.

animation

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

Type:

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)

NOTE

To specify in which position the widget will be shown and from which it will be hidden, use the position option.

buttons

Use the toolbarItems property instead.

Specifies items displayed on the top or bottom toolbar of the popup window.

Type:

Array<Object>

closeOnBackButton

A Boolean value specifying whether or not the widget is closed if a user presses the Back hardware button.

Type:

Default Value: true

closeOnOutsideClick

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

Type:

|

Function parameters:

event:

Event (jQuery or EventObject)

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

Return Value:

true if the widget should be closed; otherwise false.

Default Value: false

The function passed to this option enables you to specify a custom condition for widget closing. For instance, you can prevent closing until a user clicks a certain element.

JavaScript

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

contentTemplate

Specifies a custom template for the widget content.

Type:

template

Template Data: undefined

Default Name: 'content'

deferRendering

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

Type:

Default Value: true

disabled

Specifies whether the widget 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 option makes sense if the showTitle option 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 attributes to be attached to the widget's root element.

Type:

Default Value: {}

You can configure this option in an ASP.NET MVC Control as follows:

Razor C#

Razor VB

@(Html.DevExtreme().WidgetName()
    .ElementAttr("class", "class-name")
    // ===== or =====
    .ElementAttr(new {
        @id = "elementId",
        @class = "class-name"
    })
    // ===== or =====
    .ElementAttr(new Dictionary<string, object>() {
        { "id", "elementId" },
        { "class", "class-name" }
    })

)

@(Html.DevExtreme().WidgetName() _
    .ElementAttr("class", "class-name")
    ' ===== or =====
    .ElementAttr(New With {
        .id = "elementId",
        .class = "class-name"
    })
    ' ===== or =====
    .ElementAttr(New Dictionary(Of String, Object) From {
        { "id", "elementId" },
        { "class", "class-name" }
    })
)

focusStateEnabled

Specifies whether the widget can be focused using keyboard navigation.

Type:

Default Value: true (desktop)

fullScreen

A Boolean value specifying whether or not to display the widget in full-screen mode.

Type:

Default Value: false

height

Specifies the widget's height in pixels.

Type:

|

|

Return Value:

|

The widget's height.

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

This option 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%", "auto", "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 widget.

Type:

Default Value: undefined

hoverStateEnabled

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

Type:

Default Value: false

maxHeight

Specifies the maximum height the widget can reach while resizing.

Type:

|

|

Return Value:

|

The maximum height.

Default Value: null

This option 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%", "auto", "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 widget can reach while resizing.

Type:

|

|

Return Value:

|

The maximum width.

Default Value: null

This option 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 widget can reach while resizing.

Type:

|

|

Return Value:

|

The minimum height.

Default Value: null

This option 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%", "auto", "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 widget can reach while resizing.

Type:

|

|

Return Value:

|

The minimum width.

Default Value: null

This option 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 handler for the contentReady event. Executed when the widget's content is ready. This handler may be executed multiple times during the widget's lifetime depending on the number of times its content changes.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only when using Knockout.

Default Value: null

onDisposing

A handler for the disposing event. Executed when the widget is removed from the DOM using the remove(), empty(), or html() jQuery methods only.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if you use Knockout.

Default Value: null

onHidden

A handler for the hidden event.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if Knockout is used.

Default Value: null

Assign a function to perform a custom action after the widget is hidden.

onHiding

A handler for the hiding event.

Type:

Function parameters:

e:

Information about the event.

Object structure:

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

Default Value: null

Assign a function to perform a custom action before hiding the widget.

onInitialized

A handler for the initialized event. Executed only once, after the widget is initialized.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

Default Value: null

You cannot access widget elements in this handler because it is executed before they are ready. Use the onContentReady handler instead.

onOptionChanged

A handler for the optionChanged event. Executed after an option of the widget is changed.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
name	String	The option's short name.
model	Object	The model data. Available only if you use Knockout.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
component	Object	The widget's instance.
fullName	String	The option's full name.
value	any	The option's new value.

Default Value: null

onResize

A handler for the resize event.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if Knockout is used.

Default Value: null

Assign a function to perform a custom action each time the widget is resized by one pixel.

onResizeEnd

A handler for the resizeEnd event.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if Knockout is used.

Default Value: null

Assign a function to perform a custom action after resizing has been completed.

onResizeStart

A handler for the resizeStart event.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if Knockout is used.

Default Value: null

Assign a function to perform a custom action after resizing has been finished.

onShowing

A handler for the showing event.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if Knockout is used.

Default Value: null

Assign a function to perform a custom action before showing the widget.

onShown

A handler for the shown event.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name

Type

Description

component

The widget's instance.

element

The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.

model

The model data. Available only if Knockout is used.

Default Value: null

Assign a function to perform a custom action after the widget is shown.

onTitleRendered

A handler for the titleRendered event.

Type:

Function parameters:

e:

Information about the event.

Object structure:

Name	Type	Description
component	Object	The widget's instance.
element	HTMLElement \| jQuery	The widget's container. It is an HTML Element or a jQuery Element when you use jQuery.
model	Object	The 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

Assign a function to perform a custom action after a collection item title is rendered.

position

Positions the widget.

Type:

|

PositionConfig

|

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

This option accepts one of the following:

Position configuration object
An object that specifies the position in every detail.
String
A shortcut listed in the accepted values. Positions the widget relative to the window.
Function
A function that returns one of the above. Use it to position the widget differently depending on a condition.

When using the widget as an ASP.NET MVC Control, you can specify this option using the PositionAlignment enum. This enum accepts the following values: Bottom, Center, Left, LeftBottom, LeftTop, RightBottom, RightTop, and Top.

resizeEnabled

Specifies whether or not an end user can resize the widget.

Type:

Default Value: false

rtlEnabled

Switches the widget to a right-to-left representation.

Type:

Default Value: false

When this option is set to true, the widget 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

A Boolean value specifying whether or not the main screen is inactive while the widget is active.

Type:

Default Value: true

shadingColor

Specifies the shading color.

Type:

Default Value: ''

This option makes sense only if the shading option is set to true.

showCloseButton

Specifies whether or not the widget displays the Close button.

Type:

Default Value: false, true (desktop)

NOTE

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

showTitle

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

Type:

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 option will be passed to the tabindex attribute of the HTML element that underlies the widget.

title

The title in the overlay window.

Type:

Default Value: ''

NOTE

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

titleTemplate

Specifies a custom template for the widget title. Does not apply if the title is defined.

Type:

template

Template Data: undefined

Default Name: 'title'

toolbarItems[]

Specifies items displayed on the top or bottom toolbar of the popup window.

Type:

Array<Object>

visible

A Boolean value specifying whether or not the widget is visible.

Type: