# auro-dialog The `auro-dialog` appears on top of the page and presents information that requires the users immediate attention. ### Properties & Attributes | Properties | Attributes | Modifiers | Type | Default | Description | | --------------------- | ----------------------- | --------- | ---------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | closeButtonAppearance | close-button-appearance | | `default` \| `inverse` | `default` | Defines whether the close button should be light colored for use on dark backgrounds. | | lg | lg | | boolean | | Sets dialog box to large style. Adding both lg and sm/md will set the dialog to lg for mobile and sm/md for desktop.
Must be used in conjunction with sm or md to have an effect. | | md | md | | boolean | | Sets dialog box to medium style. Adding both md and lg will set the dialog to md for desktop and lg for mobile. | | modal | modal | | boolean | | Modal dialog restricts the user to take an action (no default close actions). | | onDark | onDark | | boolean | | DEPRECATED - use `close-button-appearance="inverse" instead. | | open | open | | boolean | | Sets state of dialog to open. | | sm | sm | | boolean | | Sets dialog box to small style. Adding both sm and lg will set the dialog to sm for desktop and lg for mobile. | | triggerElement | | | HTMLElement | | The element to focus when the dialog is closed. If not set, defaults to the value of document.activeElement when the dialog is opened. | | unformatted | unformatted | | boolean | | Unformatted dialog window, edge-to-edge fill for content. | ### Methods | Name | Parameters | Return | Description | | -------- | -------------------------------------------------------------------- | ------ | ------------------------------------------------- | | register | `name` (string) - The name of the element that you want to register. | | This will register this element with the browser. | ### Events | Name | Description | | ------ | -------------------------------------- | | toggle | Event fires when the element is closed | ### Slots | Name | Description | | ---------------------- | -------------------------------------------------------------------------------- | | ariaLabel.dialog.close | Text to describe the "x" icon close button for screen readers. Default: "Close". | | content | Injects content into the body of the modal | | footer | Used for action options, e.g. buttons | | header | Text to display as the header of the modal | ### CSS Shadow Parts | Name | Description | | -------------- | -------------------------------------------------------- | | close-button | adjust position of the close X icon in the dialog window | | dialog | apply CSS to the entire dialog | | dialog-content | apply CSS to the content of the dialog | | dialog-footer | apply CSS to the footer of the dialog | | dialog-header | apply CSS to the header of the dialog | | dialog-overlay | apply CSS on the overlay of the dialog | ## Basic
Open default dialog
Default Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
Close
See code ```html
Open default dialog
Default Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
Close
``` ## Property & Attribute Examples ### Size Options The auro-dialog supports three different sizes via attribute, `sm`, `md`, and `lg`. The default size is `lg`. #### Size Effects ##### Desktop At desktop resolutions, size affects the width of the dialog, and its height is dictated by its contents with a max height of 80%. ##### Mobile At mobile resolutions the size affects the maximum height the dialog will use of the browser viewport with a fixed width of 100%. > *Note: `lg` may be added in addition to `sm` or `md` to force the `lg` size on mobile while using the other size for desktop.* #### Single Size Examples:
Open default dialog Open medium dialog Open small dialog
Default Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
Close
Medium Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
Close
Small Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
Close
See code ```html
Open default dialog Open medium dialog Open small dialog
Default Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
Close
Medium Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
Close
Small Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
Close
``` #### Mixed Size Examples:
Open [sm lg] dialog Open [md lg] dialog
Small Modal Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
I understand
Medium Modal Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
I understand
See code ```html
Open [sm lg] dialog Open [md lg] dialog
Small Modal Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
I understand
Medium Modal Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
I understand
``` ### Modal The auro-dialog supports a modal dialog state that will lock a user into interacting with the modal dialog via the `modal` attribute. When using this state, the modal dialog must include a button action to dismiss the modal dialog as the closing icon will not be available and the user will not be able to click outside the `modal` dialog to dismiss.
Open default modal Open medium modal Open small modal
Default Modal Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
I understand
Medium Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
I understand
Small Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
I understand
See code ```html
Open default modal Open medium modal Open small modal
Default Modal Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
I understand
Medium Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
I understand
Small Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
I understand
``` ### Unformatted dialog For use case where the use of a dialog is to be more freeform, but the experience and base tooling for the dialog are still requested, there is the `unformatted` property. This property can be used in combination with any other use case of the dialog, but it will render an unformatted dialog window, allowing for full customization of content within the scope of the window. ## Slot Examples ### Close button aria-label slot To customize the aria-label text for the close button, use the `ariaLabel.dialog.close` slot to provide custom text. If no text is provided, the default text `"Close"` will be used.
Unformatted Dialog w/ custom close button aria-label
This will be the new aria label for the close button alaska airlines pride lights

This is a header

These are words that are slotted into the scope of the custom element.
See code ```html
Unformatted Dialog w/ custom close button aria-label
This will be the new aria label for the close button alaska airlines pride lights

This is a header

These are words that are slotted into the scope of the custom element.
``` ## CSS Shadow Part Examples ### Close Button The close button can be targetted via the `close-button` CSS part, e.g. `auro-dialog::part(close-button)`.
Unformatted w/custom close button
alaska airlines pride lights

Unformatted w/custom close button

Notice the custom location of the close button as well as the custom color.
See code ```html
Unformatted w/custom close button
alaska airlines pride lights

Unformatted w/custom close button

Notice the custom location of the close button as well as the custom color.
``` ## Common Usage Patterns & Functional Examples ### Dialog with Popover and Dropdown Components This is a use case where there is a popover and combobox component inside the dialog component, creating a stack of layered components.
Open dialog with popover
Small Modal Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
Hover on me Name Apples Oranges Peaches Grapes Cherries No matching option
I understand
See code ```html
Open dialog with popover
Small Modal Dialog

When traveling on Alaska Airlines flights, Alaska Airlines checked baggage fees may apply. See alaskaair.com/bagrules for our rules. For itineraries that include other airlines, their checked baggage fees may apply, as displayed on their websites.

Baggage rules and fees will be based on the specific itinerary chosen. The applicable first and second bag fees will be displayed after you have added flights to the cart.

Before checking your bags, remember to:
  • Caerphilly croque monsieur fondue
  • Taleggio goat mascarpone cow manchego cheese and wine emmental cheese strings
  • Cheddar cheese and biscuits chalk and cheese
  • Camembert de normandie stinking bishop bavarian bergkase
Hover on me Name Apples Oranges Peaches Grapes Cherries No matching option
I understand
``` ### Accessibility Within the scope of the auro-dialog there is `aria-labelledby="dialog-header"`. To make proper use of this, in an unformatted dialog, the developer is required to add `id="dialog-header"` to the content header within the dialog content.
Unformatted Medium Dialog
alaska airlines pride lights

This is a header

These are words that are slotted into the scope of the custom element.
See code ```html
Unformatted Medium Dialog
alaska airlines pride lights

This is a header

These are words that are slotted into the scope of the custom element.
``` ### Responsive padding Part of the dialog design spec is its responsive padding. To take advantage of this for your content within the scope of the dialog, be sure to use the selector `unformattedWrapper` that can be imported from the package here: ```css import '@aurodesignsystem/auro-dialog/dist/style-unformatted.scss' or import '@aurodesignsystem/auro-dialog/dist/style-unformatted.css' ``` ## Restyle Component with CSS Variables The component may be restyled by changing the values of the following token(s). ```scss @use "@aurodesignsystem/design-tokens/dist/legacy/auro-classic/SCSSVariables" as vac; @use "@aurodesignsystem/design-tokens/dist/themes/alaska/SCSSVariables--alaska" as v; :host { --ds-auro-dialog-container-color: var(--ds-basic-color-surface-default, #{v.$ds-basic-color-surface-default}); --ds-auro-dialog-boxshadow-color: var(--ds-elevation-300, #{vac.$ds-elevation-300}); --ds-auro-dialog-overlay-modal-background-color: var(--ds-advanced-color-shared-scrim, #{v.$ds-advanced-color-shared-scrim}); --ds-auro-dialog-overlay-open-background-color: var(--ds-advanced-color-shared-scrim, #{v.$ds-advanced-color-shared-scrim}); --ds-auro-dialog-text-color: var(--ds-basic-color-texticon-default, #{v.$ds-basic-color-texticon-default}); } ```