Dialog2

Ask a question Design guidelines

Summary

Modal dialogs are used to get a response from a user or reveal critical information that cannot be ignored.

Status

API status: general
Included in AUI core? Not in core You must explicitly require the web resource key.
Web resource key: com.atlassian.auiplugin:dialog2
Experimental since: 5.3
General API status: 5.8

Examples

Code

​x
 
<!-- Create a trigger which will be used by the JavaScript -->
<button id="dialog-show-button" class="aui-button">Show dialog</button>
​
<!-- Render the dialog -->
<section role="dialog" id="demo-dialog" class="aui-layer aui-dialog2 aui-dialog2-medium" aria-hidden="true">
    <!-- Dialog header -->
    <header class="aui-dialog2-header">
        <!-- The dialog's title -->
        <h2 class="aui-dialog2-header-main">Always use sentence case</h2>
        <!-- Actions to render on the right of the header -->
        <div class="aui-dialog2-header-secondary">
            <form class="aui" action="#">
                <input id="demo-search" class="text" type="search" name="search">
            </form>
        </div>
        <!-- Close icon -->
        <a class="aui-dialog2-header-close">
            <span class="aui-icon aui-icon-small aui-iconfont-close-dialog">Close</span>
        </a>
    </header>
    <!-- Main dialog content -->
    <div class="aui-dialog2-content">
        <p>Hello World</p>
    </div>
    <!-- Dialog footer -->
    <footer class="aui-dialog2-footer">
        <!-- Actions to render on the right of the footer -->
        <div class="aui-dialog2-footer-actions">
            <button id="dialog-submit-button" class="aui-button aui-button-primary">OK</button>
            <button id="dialog-next-button" class="aui-button">Next</button>
            <button id="dialog-close-button" class="aui-button aui-button-link">Close</button>
        </div>
        <!-- Hint text is rendered on the left of the footer -->
        <div class="aui-dialog2-footer-hint">this is a hint</div>
    </footer>
</section>
 
// Shows the dialog when the "Show dialog" button is clicked
AJS.$("#dialog-show-button").click(function() {
    AJS.dialog2("#demo-dialog").show();
});
​
// Hides the dialog
AJS.$("#dialog-close-button").click(function(e) {
    e.preventDefault();
    AJS.dialog2("#demo-dialog").hide();
});
​
// Show event - this is triggered when the dialog is shown
AJS.dialog2("#demo-dialog").on("show", function() {
    console.log("demo-dialog was shown");
});
​
// Hide event - this is triggered when the dialog is hidden
AJS.dialog2("#demo-dialog").on("hide", function() {
    console.log("demo-dialog was hidden");
});
​
// Global show event - this is triggered when any dialog is show
AJS.dialog2.on("show", function() {
    console.log("a dialog was shown");
});
​
// Global hide event - this is triggered when any dialog is hidden
AJS.dialog2.on("hide", function() {
    console.log("a dialog was hidden");
});

Note that in the footer, the hint text (class="aui-dialog2-footer-hint") should be placed in the DOM below the footer actions (class="aui-dialog2-footer-actions") even though the hint text appears to the left of the footer actions

Options

HTML attributes

Dialog2 configuration options are expressed through markup.

Class Description Example Usage
aui-dialog2-small | aui-dialog2-medium | aui-dialog2-large | aui-dialog2-xlarge Controls the size of the dialog according to ADG size specifications.
 
<section role="dialog" id="demo-dialog" class="aui-layer aui-dialog2 aui-dialog2-small" aria-hidden="true">
    <!-- inner content -->
</section>
.aui-dialog2-warning Gives the dialog's header a red background color.
 
<section role="dialog" id="demo-dialog" class="aui-layer aui-dialog2 aui-dialog2-warning" aria-hidden="true">
    <!-- inner content -->
</section>
Attribute Values Description Example Usage
data-aui-modal true Specifies that the dialog is modal. Modal dialogs have no close icon in the top right corner, and cannot be closed by clicking on the blanket behind it.
 
<section role="dialog" id="demo-dialog" class="aui-layer aui-dialog2 aui-dialog2-small" aria-hidden="true"
         data-aui-modal="true">
    <!-- inner content -->
</section>
data-aui-remove-on-hide true Specifies that the dialog element should be removed from the DOM when it is hidden, either by clicking on the close icon, clicking on the blanket behind the dialog, or calling the hide() method.
 
<section role="dialog" id="demo-dialog" class="aui-layer aui-dialog2 aui-dialog2-small" aria-hidden="true"
         data-aui-remove-on-hide="true">
    <!-- inner content -->
</section>
data-aui-focus-selector selector Controls the element that is focussed when the dialog is opened.
 
<section role="dialog" id="demo-dialog" class="aui-layer aui-dialog2 aui-dialog2-small" aria-hidden="true"
         data-aui-focus-selector=".aui-dialog2-content :input:visible:enabled">
    <!-- inner content -->
</section>

API

To get a reference to the API for a dialog2 instance, call AJS.dialog2(selector), where selector can be a selector string, DOM node, or jQuery element.

 
var demoDialog = AJS.dialog2("#demo-dialog");

Methods

Method Description Example Usage
show Shows a dialog.
 
AJS.dialog2("#demo-dialog").show();
hide Hides a dialog.
 
AJS.dialog2("#demo-dialog").hide();
remove Removes the dialog from the DOM.
 
AJS.dialog2("#demo-dialog").remove();

Events

Events are triggered when dialogs are shown or closed. These can be listened to for a single dialog instance, or for all dialogs.

Event Description Example Usage
show Triggered when a dialog instance is shown.
 
AJS.dialog2("#demo-dialog").on("show", function() {
    console.log("demo-dialog was shown");
});
hide Triggered when a dialog instance is hidden.
 
AJS.dialog2("#demo-dialog").on("hide", function() {
    console.log("demo-dialog was hidden");
});
global show Triggered when any dialog is shown.
 
AJS.dialog2.on("show", function() {
    console.log("a dialog was shown");
});
global hide Triggered when any dialog is hidden.
 
AJS.dialog2.on("hide", function() {
    console.log("a dialog was hidden");
});