1. Collections Component Guide
  2. Success alert
Component

Success alert

Used at the top of the page, to summarise a successful user action.

Search for usage of this component on GitHub.

How it looks (preview) (preview all)

How to call this component

<%= render "govuk_publishing_components/components/success_alert", {
  message: "Message to alert the user to a successful action goes here"
} %>

GOV.UK Design System

This component incorporates components from the GOV.UK Design System:

Accessibility acceptance criteria

  • should be focused on page load, to ensure the message is noticed by assistive tech
  • Should have a role of ‘alert’ to communicate that is a important and time sensitive message

Other examples

With message and description (preview)

Descriptions can be passed as plain text but it is strongly recommended that you pass these as html, cleaned using raw or sanitize.

<%= render "govuk_publishing_components/components/success_alert", {
  message: "Message to alert the user to a successful action goes here",
  description: sanitize("<p class=\"govuk-body\">A further description</p>")
} %>

With custom title (preview)

This is for the heading element at the head of the component (reading “Success” by default) where the id is used by an aria-labelledby on screen reader focus of the element.

Please ensure that this id is unique across the view you are building.

<%= render "govuk_publishing_components/components/success_alert", {
  message: "Message to alert the user to a successful action goes here",
  title_id: "my-custom-success-id"
} %>

With styled link (preview)

If you need to include a link in your success alert, you need to specify the govuk-link and govuk-notification-banner__link classes on that link element. This is in line with Design System guidance that the colour of the link in success notification banners can look jarring if any links are a different colour to the principal colour used by the success banner.

<%= render "govuk_publishing_components/components/success_alert", {
  message: "Message to alert the user to a successful action goes here",
  description: sanitize("<p class=\"govuk-body\">A further description with <a href=\"/a-cool-page\" class=\"govuk-link govuk-notification-banner__link\">a link</a></p>")
} %>

Long example (preview)

<%= render "govuk_publishing_components/components/success_alert", {
  message: "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Ut aliquet
    dignissim dui, ac laoreet tortor vulputate nec. Aenean quis turpis
    orci. Proin semper porttitor ipsum, vel maximus justo rutrum vel.
    Morbi volutpat facilisis libero. Donec posuere eget odio non egestas.
    Nullam sed neque quis turpis.
    "
} %>