Component

Notice

A notice to convey and highlight information

The notice component replaces the notice and withdrawal notice patterns on GOV.UK.

The component accepts either a simple string description_text parameter that it wraps in a paragraph, or a description_govspeak parameter that is rendered through govspeak for more complex HTML layout.

Search for usage of this component on GitHub.

How it looks (preview) (preview all)

How to call this component

<%= render "govuk_publishing_components/components/notice", {
  title: "Statistics release cancelled"
} %>

Accessibility acceptance criteria

The notice must:

have a border colour contrast ratio of more than 4.5:1 with its background to be visually distinct.
always render headings with associated description content, so there are no isolated heading elements inside the component

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’.

With description (preview)

<%= render "govuk_publishing_components/components/notice", {
  title: "Statistics release cancelled",
  description: sanitize("<p class=\"govuk-body\">The Oil &amp; Gas Authority launched a new website on 3 October 2016 to reflect its new status as a government company.</p><p class=\"govuk-body\">This formalises the transfer of the Secretary of State’s regulatory powers in respect of oil and gas to the OGA, and grants it new powers. This website will no longer be updated. Visitors should refer to <a class=\"govuk-link\" rel=\"external\" href=\"https://www.ogauthority.co.uk/news-publications/announcements/2015/establishment-of-the-oil-and-gas-authority-1/\">www.ogauthority.co.uk</a></p>")
} %>

With description from a block (preview)

<%= render "govuk_publishing_components/components/notice", {
  title: "Statistics release update"
} do %>
  <p class="govuk-body">The Oil &amp; Gas Authority launched a new website on 3 October 2016 to reflect its new status as a government company.</p><p class="govuk-body">This formalises the transfer of the Secretary of State’s regulatory powers in respect of oil and gas to the OGA, and grants it new powers. This website will no longer be updated. Visitors should refer to <a class="govuk-link" rel="external" href="https://www.ogauthority.co.uk/news-publications/announcements/2015/establishment-of-the-oil-and-gas-authority-1/">www.ogauthority.co.uk</a></p><% end %>

With description text (preview)

<%= render "govuk_publishing_components/components/notice", {
  title: "Statistics release cancelled",
  description_text: "Duplicate, added in error"
} %>

With description govspeak (preview)

<%= render "govuk_publishing_components/components/notice", {
  title: "Statistics release update",
  description_govspeak: sanitize("<p>The Oil &amp; Gas Authority launched a new website on 3 October 2016 to reflect its new status as a government company.</p><p>This formalises the transfer of the Secretary of State’s regulatory powers in respect of oil and gas to the OGA, and grants it new powers. This website will no longer be updated. Visitors should refer to <a rel=\"external\" href=\"https://www.ogauthority.co.uk/news-publications/announcements/2015/establishment-of-the-oil-and-gas-authority-1/\">www.ogauthority.co.uk</a></p>")
} %>

With markup in the title (preview)

In some circumstances it may be necessary to include simple markup in the title, such as a link. Note that this will be wrapped in a H2 tag if there is no description included, so be sure that any markup inserted is valid inside that tag (e.g. another heading tag inside a H2 would be invalid).

<%= render "govuk_publishing_components/components/notice", {
  title: sanitize("Advisory Committee on Novel Foods and Processes has a <a href=\"http://www.food.gov.uk/acnfp\">separate website</a>")
} %>

Without title (preview)

<%= render "govuk_publishing_components/components/notice", {
  description_govspeak: sanitize("<p>Scheduled to publish at 8am on 25 April 2019</p><ul><li><a href=\"change-date\">Change date</a></li><li><a href=\"stop-scheduled-publishing\">Stop scheduled publishing</a></li></ul>")
} %>

With aria live (preview)

Passing the aria live flag to the notice component will read the notice out to users if the notice changes, e.g on form submission the notice may go from hidden to visible.

<%= render "govuk_publishing_components/components/notice", {
  title: "Your settings have been saved",
  description_govspeak: sanitize("<p>This is a confirmation message to tell you your settings have been saved</p>"),
  aria_live: true
} %>

With locale (preview)

Passing a lang value allows the content of the notice to be labelled as being a different language from surrounding content. The lang attribute must be set to a valid BCP47 string. A valid code can be the two or three letter language code - for example, English is en or eng, Korean is ko or kor - but if in doubt please check.

<%= render "govuk_publishing_components/components/notice", {
  title: "This publication was withdrawn on 30 September 2015",
  description_govspeak: sanitize("<p>This document is no longer current. We published a new version on 30 September 2015.</p>"),
  lang: "en"
} %>

With banner title (preview)

By default, the notice component renders with a banner title of “Important” if show_banner_title is true.

<%= render "govuk_publishing_components/components/notice", {
  title: "This publication was withdrawn on 30 September 2015",
  description_govspeak: sanitize("<p>This document is no longer current. We published a new version on 30 September 2015.</p>"),
  show_banner_title: true
} %>

With custom banner title (preview)

The default banner title can be overruled by specifying a banner_title option.

<%= render "govuk_publishing_components/components/notice", {
  title: "This publication was withdrawn on 30 September 2015",
  description_govspeak: sanitize("<p>This document is no longer current. We published a new version on 30 September 2015.</p>"),
  show_banner_title: true,
  banner_title: "Information"
} %>