Page Banner

DESIGN COMPLETE IMPLEMENTATION PLANNED

A Page Banner displays an important, succinct message, and provides actions for users to address (or dismiss the banner). It requires a user action to be dismissed.


Paragon Jira tickets: https://openedx.atlassian.net/browse/PAR-277?atlOrigin=eyJpIjoiODEzNzFiYmNhZmY3NGU0NDgwZTVjZWU2MDBhZDVjZDYiLCJwIjoiaiJ9 https://openedx.atlassian.net/browse/PAR-320?atlOrigin=eyJpIjoiN2Y1ZWU0OGM0ZTZiNDFkYjhiODVkYTNhZDRhMDk5ZTciLCJwIjoiaiJ9

Design resources: https://www.figma.com/file/v9qUkOw9RUG2zkl7GVDJHq/Sitewide-banner?node-id=19%3A408


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

Global Banners

  • Page Banners that appear throughout pages of the site are known as Global Banners.

  • Today, Global Banners are the most prevalent form of Page Banners, i.e. COVID response, Cyber Monday promotion, etc.

Variants

Color variant

Primary (bright blue), Light, Dark, Warning

Dismissible

True, false (warning variant is not dismissible)


Best Practices

Do

Page Banner and System Warning Banner can appear simultaneously. However, there can only be one Page Banner at a time.

Do

Use the Page Banner component for temporary promotions-only.

Related Components

https://openedx.atlassian.net/l/c/KuRr3wzb


Specification

Behaviors

Dismissible:
It requires a user action to be dismissed.

Default persistence:
It is globally persistent and non-modal, allowing the user to either ignore them or interact with them at any time.

Note: The System Warning banner is different from https://openedx.atlassian.net/l/c/KuRr3wzb in its global persistence. The System Warning banner should be used for system warning messages impacting the global experience (i.e. IE is no longer supported,) while the Alert component should be used for messages about a specific action in a local experience (i.e. login error.)

Scrolling behavior:
When scrolling, banners should move with content and scroll off the screen.

Position:

  • Page banners should be positioned below the top navigation bar.

  • System warning banners should be positioned above the top navigation bar.

Accessibility

Implementation considerations:

1) System Warning banners are presumed to be highest priority ā€“ urgent/must-notice in every case. There are two ways to (try to) ensure this for screen reader users:
a) Give the container role=ā€alertā€ and aria-live=ā€assertiveā€. role=ā€alertā€ has an implicit aria-live=ā€assertiveā€ everywhere except for in IE11, but in this case that is just what we want, so being explicit makes it worth adding it.

The aria-live=ā€assertiveā€ value means ā€œflush the speech output queue and speak this immediately.ā€
Note: if something else on the page also has role=ā€alertā€ or aria-live=ā€assertiveā€, that downstream content flush will override this (presumably more urgent, intended) content in the speech queue, defeating the intended hierarchy of urgency on the page. So having multiple ā€œurgentā€ or ā€œalertā€ things on the page at once is tricky.

b) Put the container at the top of the page ā€“ particularly, make the content first, before any other items in the tab order.
Note: There is an Axe rule (best practice, not a strict WCAG 2.1AA requirement) saying that all content should be in one of the standard top-level containers (those being <header>, <main>, <footer>, <aside> or their ARIA equivalent roles). So if a the System Warning banner is a div above the <header>, Axe will throw a warning. In this case I might call that a false positive error (the need for urgency / noticeability overrides the desire for tidiness). But some might argue that the intent of this rule is precisely to make content more noticeable, and putting the System Warning at the top of <header> would do that. In any case, if we suppress / turn off these Axe rules, then they donā€™t help us in other more clearly relevant scenarios. So I recommend that the container for the System Warning banner should be the very first child of the <header> element.

message discoverability and navigation

2) Page banners are generally given role=ā€alertā€, but in scenarios where there are more than one present at a time, we have a repeat of point 1) above. The W3C recommends putting page-level messages in a list structure at the top of the page. Hereā€™s my recommended container structure:
<div role=ā€[Jeff check]ā€ aria-live=ā€


Notes

01.21.2021:

Implementing the component as designed, while leaving the implementation of the display rules ā€œhow many, etcā€ to a future component. We need a frame to do the orchestration of these components.

Ā