Sha256: da2a4e1dfc80d855815418962e26b5e9765dbcfa485798d71b3222c57b7fa451

Contents?: true

Size: 1.9 KB

Versions: 16

Compression:

Stored size: 1.9 KB

Contents

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_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>'

Version data entries

16 entries across 16 versions & 1 rubygems

Version Path
govuk_publishing_components-9.4.0 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.3.6 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.3.5 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.3.4 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.3.3 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.3.2 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.3.1 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.3.0 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.2.3 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.2.2 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.2.1 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.2.0 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.1.1 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.1.0 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.0.1 app/views/govuk_publishing_components/components/docs/notice.yml
govuk_publishing_components-9.0.0 app/views/govuk_publishing_components/components/docs/notice.yml