Modals

Modals

Modals are used to display content in a layer above the app. This paradigm is used in cases such as the creation or editing of a record, as well as various types of messaging and wizards.

Base

Preview

No content has been added for this component.

No content has been added for this component.

<div class="demo-only" style="height:640px;">
  <section role="dialog" tabindex="-1" aria-labelledby="modal-heading-01" aria-describedby="modal-content-id-1" class="slds-modal slds-fade-in-open">
    <div class="slds-modal__container">
      <header class="slds-modal__header">
        <button class="slds-button slds-button_icon slds-modal__close slds-button_icon-inverse" title="Close">
          <svg class="slds-button__icon slds-button__icon_large" aria-hidden="true">
            <use xlink:href="/assets/icons/utility-sprite/svg/symbols.svg#close"></use>
          </svg>
          <span class="slds-assistive-text">Close</span>
        </button>
        <h2 id="modal-heading-01" class="slds-text-heading_medium slds-hyphenate">Modal Header</h2>
      </header>
      <div class="slds-modal__content slds-p-around_medium" id="modal-content-id-1">
        <p>Sit nulla est ex deserunt exercitation anim occaecat. Nostrud ullamco deserunt aute id consequat veniam incididunt duis in sint irure nisi. Mollit officia cillum Lorem ullamco minim nostrud elit officia tempor esse quis. Cillum sunt ad dolore
          quis aute consequat ipsum magna exercitation reprehenderit magna. Tempor cupidatat consequat elit dolor adipisicing.</p>
        <p>Dolor eiusmod sunt ex incididunt cillum quis nostrud velit duis sit officia. Lorem aliqua enim laboris do dolor eiusmod officia. Mollit incididunt nisi consectetur esse laborum eiusmod pariatur proident. Eiusmod et adipisicing culpa deserunt nostrud
          ad veniam nulla aute est. Labore esse esse cupidatat amet velit id elit consequat minim ullamco mollit enim excepteur ea.</p>
      </div>
      <footer class="slds-modal__footer">
        <button class="slds-button slds-button_neutral">Cancel</button>
        <button class="slds-button slds-button_brand">Save</button>
      </footer>
    </div>
  </section>
  <div class="slds-backdrop slds-backdrop_open"></div>
</div>

About Modals

Default modals are used in the vast majority of cases. They are as wide as 50% of the viewport, but include a minimum and maximum width to avoid going too narrow or too wide.

Modals always have an equal amount of space at the top and bottom to account for the height of the close button.

Modals grow according to how much content is within, but once the modal reaches full height (including the previously mentioned space on top and bottom), the content area will begin to scroll. (This scrolling is currently not available in Salesforce1 Mobile.)

Modals can have a tagline in the header, simply by adding a paragraph after the heading.

By default, the content area of the modal does not have spacing. This allows for content such as Tables to be full-width to the modal. To get spacing when you need it, apply a padding utility (.slds-p-around--medium).

Modal headers can also have taglines, if you need to provide additional context. This tagline can also contain links, or the whole thing could be a link in and of itself.

Large modals call for large amounts of content. The height follows the same behavior and styles of other modals. The width changes to 90% of the viewport, and uses a wider minimum width and no maximum width.

These are modals that require a linearly directional paradigm of navigation (“Next” and “Back”, etc.) — the actionable buttons in the modal footer live on the left and right, rather than all on the right. These can either be within a large or default modal, depending on the use case.

Accessibility

Modals, by definition, trap focus. This means that if a user presses Tab or Shift+Tab while their keyboard focus is in the modal, their focus should stay in and cycle through the modal’s content. Focus shouldn’t return to the underlying page until the user presses the Esc key, presses an explicit “Cancel” or “Close” button in the modal, or performs another action that closes the modal.

Expected markup:

  • Modal has role="dialog"
  • When the modal is open, everything behind it has HTML attribute aria-hidden="true", so assistive technology won't read out the underlying page. The best way to do this is to give the modal and the page separate wrapper elements and toggle aria-hidden="true"/aria-hidden="false" on the main page's wrapper depending on whether or not the modal is open.
  • Modal contains an HTML heading
  • Modal has an aria-labelledby attribute whose value is the id of the modal’s heading

Expected keyboard interactions:

  • Esc key closes the modal and moves focus to whatever triggered the modal to open
  • Tab key at bottom of modal cycles focus back to first focusable element at top of modal
  • Shift+Tab keys at top of modal cycle focus back to last focusable element at bottom of modal
  • Enter key submits modal’s form data, if applicable

Overview of CSS Classes

Selector.slds-modal
Summary
Restrictsection
VariantTrue
Selector.slds-modal__container
Summary

Centers and sizes the modal horizontally and confines modal within viewport height

Restrict.slds-modal div
Selector.slds-modal__header
Summary

Creates the Modal Header container.

Restrict.slds-modal header
Selector.slds-modal__header_empty
Summary

Use when modal header has no content

Restrict.slds-modal__header
Selector.slds-modal__content
Summary

Creates the scrollable content area for the modal.

Restrict.slds-modal div
Selector.slds-modal__menu
Summary

Creates the shaded menu area for the modal.

Restrict.slds-modal div
Selector.slds-modal__footer
Summary

Creates the Modal Footer container.

Restrict.slds-modal footer
Selector.slds-modal__footer_directional
Summary

Makes buttons inside the footer spread to both left and right.

Restrict.slds-modal__footer
ModifierTrue
Selector.slds-modal__close
Summary

Positions the close button to the top right outside of the modal.

Restrict.slds-modal button
Selector.slds-modal_large
Summary

Widens the modal to take more horizontal space

Restrict.slds-modal
ModifierTrue
Selector.slds-fade-in-open
Summary

Allows the modal to be visible.

Restrict.slds-modal
ModifierTrue
Selector.slds-slide-up-open
Summary
Restrict.slds-modal
ModifierTrue
Selector.slds-slide-up-saving
Summary
Restrict.slds-modal
ModifierTrue
Selector.slds-slide-down-cancel
Summary
Restrict.slds-modal
ModifierTrue
Selector.slds-backdrop
Summary

Creates the shaded backdrop used behind the modal.

Restrict.slds-modal ~ div
Selector.slds-backdrop_open
Summary

Allows the backdrop to be visible.

Restrict.slds-backdrop
ModifierTrue