Popup

The Popup widget is a pop-up window overlaying the current view.

Included in: dx.mobile.js, dx.web.js, dx.viz-web.js, dx.all.js
Module: ui/popup
Popup interactive configuration
Copy Code
Copy to Codepen
$("#popup").dxPopup({
});

                    

You can create the widget using one of the following approaches.

  • jQuery
    Use the dxPopup jQuery plug-in.

    HTML
    <div id="popup"></div>
    JavaScript
    $("#popup").dxPopup({
        showTitle: true,
        title: 'Popup title'
    });
  • Knockout
    Add a div element and apply the dxPopup binding to this element.

    HTML
    <div data-bind="dxPopup: {
        showTitle: true,
        title: 'Popup title'
    }"></div>
  • AngularJS
    Add a div element and apply the dx-popup directive to this element.

    HTML
    <div dx-popup="{
        showTitle: true,
        title: 'Popup title'
    }"></div>

Note that DevExtreme widgets require you to link the jQuery library to your application. If you use the Knockout or AngularJS approach, the Knockout or AngularJS library is also required. For detailed information on linking these libraries to your project, refer to the Installation article.

You can find detailed information on the principles of working with the widget in the dxPopup section of the Overlay Widgets article.

View Demo

Configuration

An object defining configuration options for the Popup widget.

Name Description
accessKey

Specifies a shortcut key that sets focus on the widget element.

animation

An object defining the animation options of the widget.

closeOnBackButton

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

closeOnOutsideClick

A Boolean value specifying whether or not the widget is closed if a user clicks outside of the overlapping window.

contentTemplate

A template to be used for rendering widget content.

deferRendering

Specifies whether widget content is rendered when the widget is shown or when rendering the widget.

disabled

A Boolean value specifying whether or not the widget can respond to user interaction.

dragEnabled

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

focusStateEnabled

Specifies whether or not the widget can be focused.

fullScreen

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

height

The height of the widget in pixels.

hint

Specifies the text of the hint displayed for the widget.

hoverStateEnabled

A Boolean value specifying whether or not the widget changes its state when being hovered by an end user.

maxHeight

Specifies the maximum height the widget can reach while resizing.

maxWidth

Specifies the maximum width the widget can reach while resizing.

minHeight

Specifies the minimum height the widget can reach while resizing.

minWidth

Specifies the minimum width the widget can reach while resizing.

onContentReady

A handler for the contentReady event.

onDisposing

A handler for the disposing event.

onHidden

A handler for the hidden event.

onHiding

A handler for the hiding event.

onInitialized

A handler for the initialized event.

onOptionChanged

A handler for the optionChanged event.

onResize

A handler for the resize event.

onResizeEnd

A handler for the resizeEnd event.

onResizeStart

A handler for the resizeStart event.

onShowing

A handler for the showing event.

onShown

A handler for the shown event.

onTitleRendered

A handler for the titleRendered event.

position

An object defining widget positioning options.

resizeEnabled

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

rtlEnabled

Specifies whether or not the current component supports a right-to-left representation.

shading

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

shadingColor

Specifies the shading color.

showCloseButton

Specifies whether or not the widget displays the Close button.

showTitle

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

tabIndex

Specifies the widget tab index.

title

The title in the overlay window.

titleTemplate

A template to be used for rendering the widget title.

toolbarItems

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

visible

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

width

The widget width in pixels.

Methods

This section describes methods used to manipulate the widget.

Name Description
baseZIndex(zIndex)

A static method that specifies the base z-index for all overlay widgets.

beginUpdate()

Prevents the component from refreshing until the endUpdate() method is called.

content()

An HTML element of the widget.

defaultOptions(rule)

Specifies the device-dependent default configuration options for this component.

element()

Returns the root HTML element of the widget.

endUpdate()

Enables the component to refresh after the beginUpdate() method call.

focus()

Sets focus on the widget.

hide()

Hides the widget.

instance()

Returns an instance of this component class.

off(eventName)

Detaches all event handlers from the specified event.

off(eventName, eventHandler)

Detaches a particular event handler from the specified event.

on(eventName, eventHandler)

Subscribes to a specified event.

on(events)

Subscribes to the specified events.

option()

Returns the configuration options of this component.

option(optionName)

Gets the value of the specified configuration option of this component.

option(optionName, optionValue)

Sets a value to the specified configuration option of this component.

option(options)

Sets one or more options of this component.

registerKeyHandler(key, handler)

Registers a handler when a specified key is pressed.

repaint()

Recalculates the overlay's size and position.

show()

Shows the widget.

toggle(showing)

Toggles the visibility of the widget.

Events

This section describes events fired by this widget.

Name Description
contentReady

Fires when widget content is ready.

disposing

Fires when the widget is being removed.

hidden

Fires after the overlay is hidden.

hiding

Fires before hiding the overlay.

initialized

Fires when the widget is initialized.

optionChanged

Fires after an option of the component is changed.

resize

Fires each time the widget is resized by one pixel.

resizeEnd

Fires after resizing has been completed.

resizeStart

Fires after resizing has been started.

showing

Fires before showing the overlay.

shown

Fires after the overlay is shown.

titleRendered

Fires after the widget title is rendered.