Component

Phase banner

A banner that indicates content is in a certain phase (usually alpha or beta), with an optional explanation

Search for usage of this component on GitHub.

How it looks (preview) (preview all)

Alpha This part of GOV.UK is being built – find out what alpha means

How to call this component

<%= render "govuk_publishing_components/components/phase_banner", {
  phase: "alpha"
} %>

Accessibility acceptance criteria

The label must:

  • have a text contrast ratio higher than 4.5:1 against the background colour to meet WCAG AA

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
  • 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’
  • type - accepts any valid type attribute e.g. ‘button’, ‘submit’, ‘text’
  • rel - accepts any valid rel attribute e.g. ‘nofollow’
  • target - accepts a valid target attribute e.g. ‘_blank’
  • title - accepts any string
  • draggable - accepts a draggable attribute value (“true” or “false”)

Beta banner (preview)

Beta This part of GOV.UK is being rebuilt – find out what beta means 

<%= render "govuk_publishing_components/components/phase_banner", {
  phase: "beta"
} %>

With message (preview)

Beta This is an optional different message to explain what the state means in this context which can take HTML 

<%= render "govuk_publishing_components/components/phase_banner", {
  phase: "beta",
  message: sanitize("This is an optional different message to explain what the state means in this context which can take <a class=\"govuk-link\" href='https://www.gov.uk'>HTML</a>")
} %>

With app name (preview)

Skittles Maker Beta This part of GOV.UK is being rebuilt – find out what beta means 

<%= render "govuk_publishing_components/components/phase_banner", {
  app_name: "Skittles Maker",
  phase: "beta"
} %>

Inverse for blue background (preview)

Beta This part of GOV.UK is being rebuilt – find out what beta means 

<%= render "govuk_publishing_components/components/phase_banner", {
  phase: "beta",
  inverse: true
} %>

Inverse for blue background with app name (preview)

Skittles Maker Beta This part of GOV.UK is being rebuilt – find out what beta means 

<%= render "govuk_publishing_components/components/phase_banner", {
  app_name: "Skittles Maker",
  phase: "beta",
  inverse: 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.

Skittles Maker Beta This part of GOV.UK is being rebuilt – find out what beta means 

<%= render "govuk_publishing_components/components/phase_banner", {
  app_name: "Skittles Maker",
  phase: "beta",
  disable_ga4: true
} %>