name: Notice
description: A notice to convey and highlight information
body: |
  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.
accessibility_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
examples:
  default:
    data:
      title: 'Statistics release cancelled'
  with_description:
    data:
      title: 'Statistics release cancelled'
      description: '<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:
    data:
      title: 'Statistics release update'
      block: '<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_text:
    data:
      title: 'Statistics release cancelled'
      description_text: 'Duplicate, added in error'
  with_description_govspeak:
    data:
      title: 'Statistics release update'
      description_govspeak: '<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:
    description: 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).
    data:
      title: 'Advisory Committee on Novel Foods and Processes has a <a href="http://www.food.gov.uk/acnfp">separate website</a>'
  without_title:
    data:
      description_govspeak: '<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:
    description: 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.
    data:
      title: 'Your settings have been saved'
      description_govspeak: <p>This is a confirmation message to tell you your settings have been saved</p>
      aria_live: true
  with_locale:
    description: |
      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](https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/lang#Language_tag_syntax). 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.
    data:
      title: 'This publication was withdrawn on 30 September 2015'
      description_govspeak: <p>This document is no longer current. We published a new version on 30 September 2015.</p>
      lang: 'en'
  with_banner_title:
    description: |
      By default, the notice component renders with a banner title of "Important" if `show_banner_title` is `true`.
    data:
      title: 'This publication was withdrawn on 30 September 2015'
      description_govspeak: <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:
    description: |
      The default banner title can be overruled by specifying a `banner_title` option.
    data:
      title: 'This publication was withdrawn on 30 September 2015'
      description_govspeak: <p>This document is no longer current. We published a new version on 30 September 2015.</p>
      show_banner_title: true
      banner_title: "Information"
  with_ga4_tracking_disabled:
    description: |
      Disables GA4 tracking on the component. Tracking on the component is enabled by default. Tracking on the nested govspeak component is always disabled to prevent duplication. When tracking is enabled on this component, a data module and data attributes are added to the parent element. See the [ga4-link-tracker documentation](https://github.com/alphagov/govuk_publishing_components/blob/main/docs/analytics-ga4/ga4-link-tracker.md) for more information.
    data:
      disable_ga4: true
      title: 'This publication was withdrawn on 30 September 2015'
      description_govspeak: <p>This document is no longer current. We published a new version on 30 September 2015.</p>
      show_banner_title: true
      banner_title: "Information"