Dialog2

Summary

Modal dialogs are used to get a response from a user or reveal extra information related to a given scenario.

Usage

For the best practices on usage please refer to Atlas Kit Dialog usage documentation.

For the best practices on accessibility please refer to WAI Guidelines on Dialog.

There are also Dialog A11y specifications for AUI available inside of Atlassian.

Status

Examples

Anatomy of a dialog

Below you can see an overview of the dialog HTML pattern.

On its own, the dialog HTML pattern itself is static — the contents are added to the page inline. To ensure the dialog does not get rendered to the page, you should add aui-layer class and hidden attribute to the dialog element.

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.

Initial focus management

When working with Dialogs initial focus is one of the most important things impacting user experience.

This is how Dialog2 handles the focus:

1. find autofocus attributes in Dialog and focus the first one if found
2. if there are no autofocus attributes, find all focusable controls and focus the first one
3. if still nothing was focused, focus Dialog container element

When adding Dialog to the page, you need to think about what would be the best initial focus element in this specific Dialog. If it's not focused by default, you should consider adding autofocus attribute to it, or restructuring Dialog contents.

If you are not sure what is the best approach in your case, please refer to guides from Usage section of the page.

Opening and closing a dialog

By default the dialog closes after the close button or the blanket is clicked.

To make the dialog open and close in other cases you can use .show and .hide methods.

Focus management after dialog is closed

By default after the dialog is closed the focus returns to the element that was focused before it was opened.

However there are cases in which you have to explicitly set the focus after the dialog is closed, e.g. the element focused before dialog opening no longer exists in the document. While deciding which element should be focused keep in mind the natural flow of operation and user journey. Subscribe to hide event to achieve the required behaviour.

A warning dialog

Use this dialog type when you're representing a destructive action, and want the end-user to think more carefully about how they proceed.

Options

HTML attributes

Dialog2 configuration options are expressed through markup.

JavaScript 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.

Methods

Events

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