Skip to content

Announcements

An announcement is a message that is not tied to an element: what's new, a maintenance notice, a policy change. Create one with New content, then Announcement.

Display types

Display Description Notes
modal Centred dialog over a backdrop Size sm, md or lg. Media allowed
banner-top Full-width bar at the top Optional "Push the page down"
banner-bottom Full-width bar at the bottom Optional "Push the page down"
toast Small corner message Auto-hide is not stored as a dismissal
slideout Panel from the left or right Side left or right. Media allowed

Inline banner

The inline flag (shown in the studio as "Push the page down") pads the page body by the banner's height so the banner does not cover the host's header, and restores the author's original padding when the banner closes. It applies to banners only (decisions 42 and 67).

Settings

Trigger (a launcher trigger is not supported; use the resource centre trigger or manual), schedule, frequency, dismissible, require acknowledgement, media and up to three buttons. The acknowledge action records that the user has read it.

The app-level maxAnnouncements setting controls how many announcements may show at once. See app settings.

Worked example

A maintenance notice, shown once:

  1. New content, Announcement. Display banner-top, tick "Push the page down".
  2. Title "Planned maintenance", body "Claims search is unavailable Saturday 02:00 to 04:00."
  3. Frequency once. Schedule: start Friday, end Saturday. Dismissible on.
  4. Preview on page to confirm the host's header moves down. Publish.

Gotchas

  • inline pushes normal-flow content. A host header that is position: fixed is not pushed and the banner can still overlap it (known limit).
  • A schedule with the start after the end raises schedule-inverted. An unparseable date raises schedule-unparseable. An announcement with a launcher trigger raises trigger-unsupported.
  • Media works only on modal and slideout. It renders under a strict host Content Security Policy because it is drawn inside the player's shadow root (decision 68, checked in Chromium).
  • An announcement with the resource-center trigger appears under What's new in the help bubble and adds to its badge until viewed (the announcement-badge note in Checks says so).