Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status
colourYellowGreen
titleDRAFT
Status
titleDesign PENDINGDesign Complete
Status
titleIMPLEMENTATION PENDING

The Alert component displays a short, important message in a way that attracts the user's attention. Alerts offer four severity levels that set a distinctive icon and color.

Contributors

Related Jira Tickets

https://openedx.atlassian.net/browse/PAR-150

...

Table of Contents
maxLevel2
typeflat
separatorpipe

https://www.figma.com/file/eGmDp94FlqEr4iSqy1Uc1K/Paragon-2021?node-id=2008%3A984

...

https://www.figma.com/file/eGmDp94FlqEr4iSqy1Uc1K/Paragon-2021?node-id=2008%3A918

https://www.figma.com/file/eGmDp94FlqEr4iSqy1Uc1K/Paragon-2021?node-id=2008%3A951

🛠 Resources

🌳 Variants

Four severity level variants set a distinctive icon and color.

...

Variants

Severity levels

  • Info (default)

  • Warning

  • Danger

  • Success

Layout

Default, Stacked

https://www.figma.com/file/eGmDp94FlqEr4iSqy1Uc1K/Paragon-2021?node-id=2008%3A880

...

🌞 Best Practices

Tip

Do

Use the Stacked variant in sidebars

Use the Stacked variant at the extra-small breakpoint and smaller

Make all banners dismissible, unless they contain critical information or an important action that users are required to take

Warning

Don't

Do not place an icon in the Info variant

Alert banners should never grow larger than outer max-width

♊ Related Components

...

📐 Specification

https://www.figma.com/file/eGmDp94FlqEr4iSqy1Uc1K/Paragon-2021?node-id=2008%3A1009

...

♒ Behaviors

💕 Accessibility

Focus Management Expectations

Semantics

Using color to add meaning only provides a visual indication, which will not be conveyed to users of assistive technologies – such as screen readers. Ensure that information denoted by the color is either obvious from the content itself (e.g. the visible text), or is included through alternative means, such as additional text hidden with the .sr-only class.