Component

Emergency banner

A site-wide banner used in the event of an emergency

There are three types of events that would lead GOV.UK to add an emergency banner to the top of each page on the web site; a notable death, a national emergency or a local emergency.

See the opsmanual for information about what the Emergency Banner is and when it should be deployed.

Search for usage of this component on GitHub.

How it looks (preview) (preview all)

How to call this component

<%= render "govuk_publishing_components/components/emergency_banner", {
  campaign_class: "notable-death",
  heading: "His Royal Highness Henry VIII",
  short_description: "1491 to 1547",
  link_text: "Override Link Text",
  link: "https://www.gov.uk/"
} %>

Accessibility acceptance criteria

Links in the component must:

accept focus
be focusable with a keyboard
be usable with a keyboard
indicate when they have focus
change in appearance when touched (in the touch-down state)
change in appearance when hovered
be usable with touch
be usable with voice commands
have visible text
have meaningful text

Other examples

Standard options

This component uses the component wrapper helper. It accepts the following options and applies them to the parent element of the component. See the component wrapper helper documentation for more detail.

id - accepts a string for the element ID attribute
data_attributes - accepts a hash of data attributes
aria - accepts a hash of aria attributes
classes - accepts a space separated string of classes, these should not be used for styling and must be prefixed with js-
margin_bottom - accepts a number from 0 to 9 (0px to 60px) using the GOV.UK Frontend spacing scale (defaults to no margin)
role - accepts a space separated string of roles
lang - accepts a language attribute value
open - accepts an open attribute value (true or false)
hidden - accepts an empty string, ‘hidden’, or ‘until-found’
tabindex - accepts an integer. The integer can also be passed as a string.
dir - accepts ‘rtl’, ‘ltr’, or ‘auto’.

National emergency (preview)

National emergency (level 1 or category 2)

<%= render "govuk_publishing_components/components/emergency_banner", {
  campaign_class: "national-emergency",
  heading: "National emergency",
  short_description: "This is a level 1 incident",
  link: "https://www.gov.uk/"
} %>

Local emergency (preview)

Localised large-scale emergency (level 2 or category 1)

<%= render "govuk_publishing_components/components/emergency_banner", {
  campaign_class: "local-emergency",
  heading: "Local emergency",
  short_description: "This is a level 2 incident",
  link: "https://www.gov.uk/"
} %>

Notable death homepage (preview)

When presenting any type of emergency banner on homepage the styling is slightly different.

<%= render "govuk_publishing_components/components/emergency_banner", {
  campaign_class: "notable-death",
  heading: "His Royal Highness Henry VIII",
  short_description: "1491 to 1547",
  link: "https://www.gov.uk/",
  homepage: true
} %>

Without ga4 tracking (preview)

Disables GA4 tracking on the banner. Tracking is enabled by default. This includes link tracking on the component itself, and allows pageviews to record the presence of the banner on page load.

<%= render "govuk_publishing_components/components/emergency_banner", {
  campaign_class: "notable-death",
  heading: "His Royal Highness Henry VIII",
  short_description: "1491 to 1547",
  link: "https://www.gov.uk/",
  homepage: true,
  disable_ga4: true
} %>