Inline Dialog

Summary

A container for secondary content/controls to be displayed on user request. Consider this component as displayed in context to the triggering control with the dialog overlaying the page content.

An inline dialog should be preferred over a modal dialog when a connection between the action has a clear benefit versus having a lower user focus.

Status

Behaviour

Triggering

An inline dialog can be opened by a Trigger element. Any interactive element can be made in to a trigger — the typical elements to use are either button or a

Associate a trigger (data-aui-trigger) to an inline dialog by setting the trigger element's aria-controls attribute to the id of the inline dialog:

<a data-aui-trigger aria-controls="more-details" href="#more-details">

    A hyperlink as a trigger

</a>

<button data-aui-trigger aria-controls="more-details">

    A button as a trigger

</button>

<aui-inline-dialog id="more-details">

    <p>Lorem ipsum.</p>

</aui-inline-dialog>

Opening

An inline dialog will, by default, open when a user clicks its trigger, but can be made to open:

• programmatically,
• automatically at page load, or
• when hovering over its trigger.

Programmatically opening

To programmatically open an inline dialog, set its open property or add the open boolean attribute:

var inlineDialog = document.getElementById('my-inline-dialog');

inlineDialog.open = true;

inlineDialog.setAttribute('open', '');  // Equivalent to line above.

Opening at page load

To make an inline dialog open at page load, simply specify the open boolean attribute:

<a data-aui-trigger aria-controls="start-open" href="#start-open">

    This inline dialog starts open

</a>

<aui-inline-dialog id="start-open" open>

    <p>Lorem ipsum.</p>

    <a class="aui-button aui-button-link">Close</a>

</aui-inline-dialog>

Opening by hovering over the trigger

Make an inline dialog show when hovering over the trigger by setting the inline dialog's responds-to attribute:

<a data-aui-trigger aria-controls="show-on-hover" href="#show-on-hover">

    Hover to show contents

</a>

<aui-inline-dialog id="show-on-hover" responds-to="hover">

    <p>Lorem ipsum.</p>

</aui-inline-dialog>

Or by setting the respondsTo JavaScript property:

var inlineDialog = document.getElementById('show-on-hover')

inlineDialog.respondsTo = 'hover';

Closing

Inline dialogs will automatically close when the user clicks outside the inline dialog or presses ESC. Inline dialogs that open on hover close when the user stops hovering over either the trigger or the inline dialog itself.

An inline dialog that is set to not automatically close can only be closed programmatically, e.g., via an event handler bound to a close button.

Programmatically closing

To programmatically close an inline dialog, set its open property or remove its open attribute:

var inlineDialog = document.getElementById('my-inline-dialog');

inlineDialog.open = false;

inlineDialog.removeAttribute('open');  // Equivalent to line above.

Prevent automatic closing

Inline dialogs can be forced to remain open via the persistent boolean attribute:

<a data-aui-trigger aria-controls="stays-open" href="#stays-open">

    This inline dialog stays open

</a>

<aui-inline-dialog id="stays-open" persistent>

    <p>Lorem ipsum.</p>

    <a class="aui-button aui-button-link">Close</a>

</aui-inline-dialog>

Or by setting the persistent JavaScript property:

var inlineDialog = document.getElementById('stays-open')

inlineDialog.persistent = true;

Appearance

Alignment

An inline dialog can be aligned, relative to its trigger, along twelve different points, via the alignment attribute:

<a data-aui-trigger aria-controls="align-bottom-right" href="#align-bottom-right">

    Bottom right alignment

</a>

<aui-inline-dialog id="align-bottom-right" alignment="bottom right">

    <p>Lorem ipsum.</p>

</aui-inline-dialog>

The alignment attribute takes two positional arguments in the format alignment="edge edge-position", where

• edge specifies what edge to align the inline dialog's arrow to, and
• edge-position specifies where on that edge the arrow should appear.

See the alignment API reference for all valid combinations, or test the combinations below:

Space-constrained alignment

If there is not enough room to display an inline dialog with the desired alignment the inline dialog will flip alignment.

<a data-aui-trigger aria-controls="try-right-middle" href="#try-right-middle">

    Right middle alignment, but flips left

</a>

<aui-inline-dialog id="try-right-middle" alignment="right middle">

    <p>Lorem ipsum.</p>

</aui-inline-dialog>

API Reference

Attributes and properties

Methods

There are no methods.

Events

Events are triggered when inline dialogs are shown and hidden. These events are triggered natively on the component. You can bind to the the inline dialog element for instance specific events, or rely on event bubbling and bind to the document to receive events for every show and hide.