The page navigation is complete. You may now navigate the page content as you wish.
Skip to main content

Displays additional details and information about an item or object, overlaid on the main page content.

A Flyout is used to show and hide additional information and content that is related to the main page without navigating or routing to a new page.


When to use

  • When displaying additional information, context, or details that extend or enhance an object or element on the main page.
  • To present functions that are secondary to the main page or user flow.
  • To preview content without navigating or routing to a new page.

When not to use

  • When requesting information or feedback from the user through a form. Instead, use a Modal or consider moving the content to its own page.
  • When displaying overly complex information, consider moving the content to its own page.

Flyout vs Modal

While similar in functionality and interaction, the Flyout and Modal are meant to be used in different scenarios and to express different types of content. There is a fair amount of overlap in their usage but they differ in complexity, status and messaging, speed and regularity, and experience hierarchy.


A Flyout is useful for more complex content, given the space it occupies in the viewport, while Modals are useful for less complex content that can be interacted with quickly.

Note: Complexity of content is relative, use your own judgment to determine if the content or function is overly complex and consider moving it to its own page.

Status and messaging

Flyouts are useful when displaying detailed content that relates to the page, while Modals are useful for messaging status, e.g., confirming a destructive action or warning about the effects of a change.

Speed and regularity

Modals are better suited for quick interactions that occur infrequently, while Flyouts, due to their support for more complex content, can occupy more of the users’ time and be recalled more frequently.

Experience hierarchy

While each of these components is triggered by a user action, where they exist in the flow is fundamentally different:

  • A Modal blocks the user from progressing further in the main flow (Fig 1.0), forcing them to take action or make a decision.
  • A Flyout extends or "branches" off from the main flow to add detail and highlight secondary features and functions (Fig 1.1).
  • Rather than blocking the user from continuing in the main flow, a Flyout enhances and adds detail to the flow to aid in the completion of a function.

Fig. 1.0: Hierarchy representation of a Modal blocking the user progression through a flow.

Modal Hierarchy in the user flow

Fig. 1.1: Hierarchy representation of the Flyout relative to the user flow.

Flyout hierarchy in the user flow

Usage examples

Preview content

Previewing read-only content is an ideal use case for a Flyout as it keeps the user in the context of the current flow while detailing additional secondary information.


Use a Flyout as a detailed preview of an object on the main page.

Flyout with preview content

Code snippets and examples

While code snippets and terminal scripts are usually detailed, they are well suited content within a Flyout due to their contextual relevancy to the content on the page, while maybe not being complex enough to exist on their own page.


Flyout with code snippet


Don't use a form in a Flyout, whether the function is creating an object, or updating an existing one. This type of content is often complex and more appropriate on its own page, or in the case of a simple form, within a Modal.


Form within a Flyout



Medium Flyout

Flyout content


Large Flyout

Flyout content

Best practices

Sizes of the Flyout

  • Use a Flyout size that best accounts for the complexity and detail of the content.
  • The medium size accounts for the majority of scenarios and is the default recommended size.

Flyout header

The Flyout header features several properties to better communicate the purpose and content within the component.

Title icon

With title icon


Without title icon



An icon paired with the title can help reinforce the purpose and function of the Flyout while also drawing the eye to the header and title area.

The purpose and function of the Flyout should not rely solely on an icon, instead the title should be explicit and pragmatic while the icon provides visual support.


With tagline


With tagline and icon


A tagline helps the user maintain the context of the main page the Flyout was triggered from. Since a Flyout disables and obscures the main page content, adding a tagline can help the user understand the relationship between the Flyout and the main page.

The tagline should directly reference the page, feature title, or object to reinforce the purpose of the Flyout.

Even though adding a title icon and tagline can help the user better understand the content, both elements add visual weight which might not be suitable or necessary for all Flyouts.


A description provides additional information about the Flyout.

With description


With description and icon


Flyout body

The body of the Flyout supports any custom content, local components, or Helios components via an instance swap property (customInstance) in Figma. In code, yield is supported.

The Flyout footer is a persistent content area at the bottom of the Flyout, and supports additional descriptive content, links, actions, and any other custom content or Helios components.

The Ember and Figma components account for the footer in slightly different ways, though both can achieve the same results:

  • The Ember component is a generic container that yields elements passed to it.
  • The Figma component consists of a variant for the number of actions, as well as support for custom content with instance swap.

The footer is optional and should be used sparingly as it increases the complexity of the Flyout.

With one action

With two actions

For more guidance and details around organizing buttons and actions, refer to the Button organization pattern documentation.


A Flyout supports actions within the footer allowing for basic functions to be performed. This usage should be limited to performing secondary functions that are related to the main page to help the user maintain context in the primary flow. Some examples of this are:

  • Batch updating and creating relationships between one or more objects
  • Linking to external resources using a link that appears as a button

Use a Flyout for actions like batch selection that are secondary to the main page.

Simple actions within a Flyout


Use a Flyout for simple declarative content like text and links that enhance the main page.

Complex footer example


Don't use a Flyout for editing or creating objects. These are generally considered primary functions and should be handled on their own page or within a Modal in simple scenarios.

Complex actions within a Flyout


The primary dismissal method for the Flyout is the dismiss action in the header. The Flyout does not support action buttons to “confirm” or “cancel” the Flyout as the component is not intended to perform functions.

Multiple dismissal options are available that can be customized in production with a callback (on onClose, or onOpen) function:

  • Dismiss button in the header
  • Clicking with a mouse outside of the Flyout on the main page
  • Hitting the escape (ESC) key on a keyboard

Flyout dismissal actions

Positioning and responsive sizing

A Flyout should slide out from the right side of the viewport on top of the main page content and occupy 100% of the viewport height.

  • This is true regardless of whether there is a sidebar or navigational element that persists on the page.
  • A Flyout should overlay all content and block/disable interaction on the main page.

Flyout in a desktop viewport

In Figma, the Flyout should be paired with the overlay component which obscures the main page content the Flyout sits on top of. Using the Flyout without the overlay is currently not supported and helps to communicate visually the inert nature of the main page.

On smaller viewports, the Flyout should occupy 100% of the viewport width minus half the size of the minimized SideNav width from the viewport edge.

  • If the body content of the Flyout exceeds the maximum height of the viewport, a scroll will be introduced.
  • The Flyout header is not included in the scrolling section, only the body content. The header should always be visible to help the user understand the Flyout content and how it relates to the main page.
  • The Flyout should not be resized manually, rather select the size that best accommodates the content.

Browser support

The Flyout component leverages the <dialog> element which is currently supported by all major browser vendors.

Page scroll

When a Flyout is open, the rest of the page becomes inert. The page scrolling is also disabled by applying overflow: hidden to the <body> element, to make it clear to the user that the underlying elements are not interactive and to avoid confusion. Depending on users’ scroll bar settings, opening a Flyout may cause slight layout shifts on the horizontal axis.


As an overlaying component, the Hds::Flyout is rendered on the top layer, meaning it is always placed on top of all other elements in the page.

Focus trap

This component uses ember-focus-trap to prevent the focus from going outside the Flyout and to deactivate the Flyout when clicking outside. This Ember modifier requires at least one interactive element to be present within the Flyout, which is by default achieved by the dismiss button in the header.

How to use this component

  @text="Open Flyout"
  {{on "click" (fn this.activateFlyout "basicFlyoutActive")}}

{{#if this.basicFlyoutActive}}
  <Hds::Flyout id="basic-flyout"
    @onClose={{fn this.deactivateFlyout "basicFlyoutActive"}} as |M|>
    <M.Header @tagline="Main page context" @icon="info">
      Additional information
      Lorem ipsum dolor sit amet consectetur.
      Ut ultrices id venenatis in felis auctor ante.
      <p class="hds-typography-body-300 hds-foreground-primary">
        Aliquam ac enim iaculis, faucibus enim id, dapibus quam.
        Nunc nibh mi, vehicula sed enim eget, lacinia venenatis tortor.
        Quisque vitae accumsan est, eu vehicula arcu.

When a Flyout is opened with the keyboard, the focus is automatically set to the first focusable element inside the Flyout, which is the “Dismiss” button.

Component API


<[F].Header> yielded component
Flyout::Header yielded as contextual component (see below).
<[F].Description> yielded component
Flyout::Header yielded as contextual component (see below).
<[F].Body> yielded component
Flyout::Header yielded as contextual component (see below).
<[F].Footer> yielded component
Flyout::Header yielded as contextual component (see below).
size enum
  • medium (default)
  • large
Sets the width of the Flyout.
onOpen function
Callback function invoked when the Flyout is opened.
onClose function
Callback function invoked when the Flyout is closed.
This component supports use of ...attributes.

Contextual components


The Flyout::Header component, yielded as contextual component.

icon string
Icon name.
tagline string
A string that helps the user maintain context when a Flyout is open.
This is not the title text, but a small piece of text above the title text.
Elements passed as children are yielded as inner content of the "title" block.
This component supports use of ...attributes.


The Flyout::Description component, yielded as contextual component.

Elements passed as children are yielded as inner content of the "description" block.
This component supports use of ...attributes.


The Flyout::Body component, yielded as contextual component.

Elements passed as children are yielded as inner content of the "body" block.
The content is unstyled by default, so consumers will need to take care of layout and style of the content.
When the content exceeds the available space, a scrollbar is introduced to the container.
This component supports use of ...attributes.


The Flyout::Footer component, yielded as contextual component.

Elements passed as children are yielded as inner content of the "footer" block.
We recommend using it exclusively for declarative content or actions using the ButtonSet component.
If a tertiary action is presented, it will always be aligned at the end of the row.
close function
Function to programmatically close the Flyout. If an onClose callback function is provided, it will be invoked when the Flyout is closed.
This component supports use of ...attributes.


Flyout anatomy

Element Usage
TitleIcon Optional
Description Optional
Tagline Optional
Title Required
Dismiss button Required
Body Required; accepts any custom component instance (local or from Helios)
Footer Optional
Actions Optional; either none, one, two, or three
Custom Content Optional; accepts any custom component instance (local or from Helios)



The Flyout component is conformant when used as directed.


When a Flyout is triggered, focus is trapped within the component. The dismiss button should receive focus as the first interactive element in the DOM (document object model).

Focus order within a simple Flyout

Applicable WCAG Success Criteria

This section is for reference only, some descriptions have been truncated for brevity. This component intends to conform to the following WCAG Success Criteria:

  • 1.1.1 Non-text Content (Level A):
    All non-text content that is presented to the user has a text alternative that serves the equivalent purpose.
  • 1.3.1 Info and Relationships (Level A):
    Information, structure, and relationships conveyed through presentation can be programmatically determined or are available in text.
  • 1.3.2 Meaningful Sequence (Level A):
    When the sequence in which content is presented affects its meaning, a correct reading sequence can be programmatically determined.
  • 1.3.3 Sensory Characteristics (Level A):
    Instructions provided for understanding and operating content do not rely solely on sensory characteristics of components such as shape, color, size, visual location, orientation, or sound.
  • 1.3.5 Identify Input Purpose (Level AA):
    The purpose of each input field collecting information about the user can be programmatically determined when the input field serves a purpose identified in the Input Purposes for User Interface Components section; and the content is implemented using technologies with support for identifying the expected meaning for form input data.
  • 1.4.1 Use of Color (Level A):
    Color is not used as the only visual means of conveying information, indicating an action, prompting a response, or distinguishing a visual element.
  • 1.4.10 Reflow (Level AA):
    Content can be presented without loss of information or functionality, and without requiring scrolling in two dimensions.
  • 1.4.11 Non-text Contrast (Level AA):
    The visual presentation of the following have a contrast ratio of at least 3:1 against adjacent color(s): user interface components; graphical objects.
  • 1.4.12 Text Spacing (Level AA):
    No loss of content or functionality occurs by setting all of the following and by changing no other style property: line height set to 1.5; spacing following paragraphs set to at least 2x the font size; letter-spacing set at least 0.12x of the font size, word spacing set to at least 0.16 times the font size.
  • 1.4.13 Content on Hover or Focus (Level AA):
    Where receiving and then removing pointer hover or keyboard focus triggers additional content to become visible and then hidden, the following are true: dismissible, hoverable, persistent (see link).
  • 1.4.3 Minimum Contrast (Level AA):
    The visual presentation of text and images of text has a contrast ratio of at least 4.5:1
  • 1.4.4 Resize Text (Level AA):
    Except for captions and images of text, text can be resized without assistive technology up to 200 percent without loss of content or functionality.
  • 1.4.5 Images of Text (Level AA):
    This is old. Don’t do this. Use text. Also a logo is not an image of text, so that’s fine.
  • 2.1.1 Keyboard (Level A):
    All functionality of the content is operable through a keyboard interface.
  • 2.1.2 No Keyboard Trap (Level A):
    If keyboard focus can be moved to a component of the page using a keyboard interface, then focus can be moved away from that component using only a keyboard interface.
  • 2.1.4 Character Key Shortcuts (Level A):
    If a keyboard shortcut is implemented in content using only letter (including upper- and lower-case letters), punctuation, number, or symbol characters, then it should be able to be turned off, remapped, or active only on focus.
  • 2.4.2 Page Titled (Level A):
    Web pages have titles that describe topic or purpose.
  • 2.4.3 Focus Order (Level A):
    If a Web page can be navigated sequentially and the navigation sequences affect meaning or operation, focusable components receive focus in an order that preserves meaning and operability.
  • 2.4.6 Headings and Labels (Level AA):
    Headings and labels describe topic or purpose.
  • 2.4.7 Focus Visible (Level AA):
    Any keyboard operable user interface has a mode of operation where the keyboard focus indicator is visible.
  • 3.2.1 On Focus (Level A):
    When any user interface component receives focus, it does not initiate a change of context.
  • 3.2.2 On Input (Level A):
    Changing the setting of any user interface component does not automatically cause a change of context unless the user has been advised of the behavior before using the component.
  • 3.3.1 Error Identification (Level A):
    If an input error is automatically detected, the item that is in error is identified and the error is described to the user in text.
  • 3.3.2 Labels or Instructions (Level A):
    Labels or instructions are provided when content requires user input.
  • 3.3.3 Error Suggestion (Level AA):
    If an input error is automatically detected and suggestions for correction are known, then the suggestions are provided to the user, unless it would jeopardize the security or purpose of the content.
  • 3.3.4 Error Prevention (Legal, Financial, Data) (Level AA):
    For Web pages that cause legal commitments or financial transactions for the user to occur, that modify or delete user-controllable data in data storage systems, or that submit user test responses, at least one of the following is true: submissions are reversible, data is checked and user is provided an opportunity to correct them, a mechanism is available for reviewing, confirming and correcting the information before finalizing the submission.
  • 4.1.2 Name, Role, Value (Level A):
    For all user interface components, the name and role can be programmatically determined; states, properties, and values that can be set by the user can be programmatically set; and notification of changes to these items is available to user agents, including assistive technologies.
  • 4.1.3 Status Messages (Level AA):
    In content implemented using markup languages, status messages can be programmatically determined through role or properties such that they can be presented to the user by assistive technologies without receiving focus.


If any accessibility issues have been found within this component, let us know by submitting an issue.