Show and Hide the Popup

API

NOTE
In this article, the Button widget is used to demonstrate how to show and hide the Popup. This choice is made for purely demonstrational purposes, and you can do the same operations using another widget following the same guidelines.

To show or hide the Popup programmatically, call the show() or hide() method. The same thing can be done using the toggle(showing) method. Pass true or false to this method to show or hide the Popup, respectively.

jQuery

JavaScript
$(function() {
    $("#popupContainer").dxPopup({
        title: "Popup Title",
        contentTemplate: function () {
            return $("<p />").text("Popup content");
        }
    });

    $("#showButton").dxButton({
        text: "Show the Popup", 
        onClick: function () {
            $("#popupContainer").dxPopup("show");
            // ---------- or ----------
            $("#popupContainer").dxPopup("toggle", true);
        } 
    });

    $("#hideButton").dxButton({
        text: "Hide the Popup", 
        onClick: function () {
            $("#popupContainer").dxPopup("hide");
            // ---------- or ----------
            $("#popupContainer").dxPopup("toggle", false);
        } 
    });
});

ASP.NET MVC Wrappers

@(Html.DevExtreme().Popup()
    .ID("popup")
    .Title("Popup Title")
    .ContentTemplate(@<text>
        <p>Popup content</p>
    </text>)
)

@(Html.DevExtreme().Button()
    .ID("showButton")
    .Text("Show the Popup")
    .OnClick(@<text>
        function () {
            $("#popup").dxPopup("show");
            // ---------- or ----------
            $("#popup").dxPopup("toggle", true);
        } 
    </text>)
)

@(Html.DevExtreme().Button()
    .ID("hideButton")
    .Text("Hide the Popup")
    .OnClick(@<text>
        function () {
            $("#popup").dxPopup("hide");
            // ---------- or ----------
            $("#popup").dxPopup("toggle", false);
        } 
    </text>)
)

With AngularJS or Knockout, use a different technique. Bind the visible property of the Popup widget to a scope property (in AngularJS) or an observable variable (in Knockout). After that, change this scope property or observable variable, and the Popup will appear or disappear.

AngularJS

HTML
<div ng-controller="DemoController">
    <div dx-popup="{
        title: 'Popup Title',
        bindingOptions: {
            visible: 'isPopupVisible'
        }
    }">
        <p>Popup Content</p>
    </div>
    <div dx-button="{
        text: 'Show the Popup',
        onClick: showPopup
    }"></div>
    <div dx-button="{
        text: 'Hide the Popup',
        onClick: hidePopup
    }"></div>
</div>
JavaScript
angular.module('DemoApp', ['dx'])
    .controller('DemoController', function DemoController($scope) {
        $scope.isPopupVisible = false;
        $scope.showPopup = function () {
            $scope.isPopupVisible = true;
        };
        $scope.hidePopup = function () {
            $scope.isPopupVisible = false;
        };
    });

Knockout

HTML
<div data-bind="dxPopup: {
    title: 'Popup Title',
    visible: isPopupVisible
}">
    <p>Popup Content</p>
</div>
<div data-bind="dxButton: {
    text: 'Show the Popup',
    onClick: function (e) {
        e.model.isPopupVisible(true);
    }
}"></div>
<div data-bind="dxButton: {
    text: 'Hide the Popup',
    onClick: function (e) {
        e.model.isPopupVisible(false);
    }
}"></div>
JavaScript
var viewModel = {
    isPopupVisible: ko.observable(false)
};

ko.applyBindings(viewModel);

User Interaction

The Popup can also be hidden when a user clicks outside it or presses the Back button on the device. To control this behavior of the Popup, use the closeOnBackButton and closeOnOutsideClick options.

JavaScript
$(function() {
    $("#popupContainer").dxPopup({
        title: "Popup Title",
        closeOnBackButton: false,
        closeOnOutsideClick: true
    });
});

Events

To execute certain commands before or after the Popup was shown/hidden, handle the showing, shown, hiding or hidden event. If the event handling function is not going to be changed during the lifetime of the widget, assign it to the corresponding onEventName option when you configure the widget.

JavaScript
$(function () {
    $("#popupContainer").dxPopup({
        // ...
        onShowing: function (e) {
            // Handler of the "showing" event
        },
        onShown: function (e) {
            // Handler of the "shown" event
        },
        onHiding: function (e) {
            // Handler of the "hiding" event
        },
        onHidden: function (e) {
            // Handler of the "hidden" event
        }
    });
});

If you are going to change event handlers at runtime, or if you need to attach several handlers to a single event, subscribe to the events using the on(eventName, eventHandler) method.

JavaScript
var hiddenEventHandler1 = function (e) {
    // First handler of the "hidden" event
};

var hiddenEventHandler2 = function (e) {
    // Second handler of the "hidden" event
};

$("#popupContainer").dxPopup("instance")
    .on('hidden', hiddenEventHandler1)
    .on('hidden', hiddenEventHandler2);
See Also