Components

Notification banner

Experimental

This component is currently experimental because [more research] is needed to validate it.

Use a notification banner to tell the user about something they need to know about, but that’s not directly related to the page content.

HTML
React

<div
  class="govuk-notification-banner"
  role="region"
  aria-labelledby="govuk-notification-banner-title"
  data-module="govuk-notification-banner"
>
  <div class="govuk-notification-banner__header">
    <h2
      class="govuk-notification-banner__title"
      id="govuk-notification-banner-title"
    >
      Important
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <p class="govuk-notification-banner__heading">
      You have 7 days left to send your application.
      <a
        class="govuk-notification-banner__link"
        href="#"
      >
        View application
      </a>
      .
    </p>
  </div>
</div>

<NotificationBanner>
  <p class="govuk-notification-banner__heading">
    You have 7 days left to send your application.{" "}
    <a
      class="govuk-notification-banner__link"
      href="#"
    >
      View application
    </a>
    .
  </p>
</NotificationBanner>

Props

Name	Type	Description
id	string	'id' attribute to place on the base HTML element
classBlock	string	Block name override in BEM style classes applied to all elements
classModifiers	other	BEM style modifiers to apply to the base HTML element
className	string	Extra classes to apply to the base HTML element
defaultChecked	boolean
defaultValue	other
suppressContentEditableWarning	boolean
suppressHydrationWarning	boolean
accessKey	string
autoFocus	boolean
contentEditable	other
contextMenu	string
dir	string
draggable	other
hidden	boolean
lang	string
nonce	string
slot	string
spellCheck	other
style	other
tabIndex	number
title	other	The title that displays in the notification banner. The available default values are 'Important' and 'Success' depending on how 'type' has been set.
translate	enum
radioGroup	string
role	other
about	string
content	string
datatype	string
inlist	other
prefix	string
property	string
rel	string
resource	string
rev	string
typeof	string
vocab	string
autoCapitalize	string
autoCorrect	string
autoSave	string
color	string
itemProp	string
itemScope	boolean
itemType	string
itemID	string
itemRef	string
results	number
security	string
unselectable	enum
inputMode	enum	Hints at the type of data that might be entered by the user while editing the element or its contents
is	string	Specify that a standard HTML element should behave like a defined custom built-in element
aria-activedescendant	string	Identifies the currently active element when DOM focus is on a composite widget, textbox, group, or application.
aria-atomic	other	Indicates whether assistive technologies will present all, or only parts of, the changed region based on the change notifications defined by the aria-relevant attribute.
aria-autocomplete	enum	Indicates whether inputting text could trigger display of one or more predictions of the user's intended value for an input and specifies how predictions would be presented if they are made.
aria-braillelabel	string	Defines a string value that labels the current element, which is intended to be converted into Braille.
aria-brailleroledescription	string	Defines a human-readable, author-localized abbreviated description for the role of an element, which is intended to be converted into Braille.
aria-busy	other
aria-checked	other	Indicates the current "checked" state of checkboxes, radio buttons, and other widgets.
aria-colcount	number	Defines the total number of columns in a table, grid, or treegrid.
aria-colindex	number	Defines an element's column index or position with respect to the total number of columns within a table, grid, or treegrid.
aria-colindextext	string	Defines a human readable text alternative of aria-colindex.
aria-colspan	number	Defines the number of columns spanned by a cell or gridcell within a table, grid, or treegrid.
aria-controls	string	Identifies the element (or elements) whose contents or presence are controlled by the current element.
aria-current	other	Indicates the element that represents the current item within a container or set of related elements.
aria-describedby	string	Identifies the element (or elements) that describes the object.
aria-description	string	Defines a string value that describes or annotates the current element.
aria-details	string	Identifies the element that provides a detailed, extended description for the object.
aria-disabled	other	Indicates that the element is perceivable but disabled, so it is not editable or otherwise operable.
aria-dropeffect	enum	Indicates what functions can be performed when a dragged object is released on the drop target.
aria-errormessage	string	Identifies the element that provides an error message for the object.
aria-expanded	other	Indicates whether the element, or another grouping element it controls, is currently expanded or collapsed.
aria-flowto	string	Identifies the next element (or elements) in an alternate reading order of content which, at the user's discretion, allows assistive technology to override the general default of reading in document source order.
aria-grabbed	other	Indicates an element's "grabbed" state in a drag-and-drop operation.
aria-haspopup	other	Indicates the availability and type of interactive popup element, such as menu or dialog, that can be triggered by an element.
aria-hidden	other	Indicates whether the element is exposed to an accessibility API.
aria-invalid	other	Indicates the entered value does not conform to the format expected by the application.
aria-keyshortcuts	string	Indicates keyboard shortcuts that an author has implemented to activate or give focus to an element.
aria-label	string	Defines a string value that labels the current element.
aria-labelledby	string	Identifies the element (or elements) that labels the current element.
aria-level	number	Defines the hierarchical level of an element within a structure.
aria-live	enum	Indicates that an element will be updated, and describes the types of updates the user agents, assistive technologies, and user can expect from the live region.
aria-modal	other	Indicates whether an element is modal when displayed.
aria-multiline	other	Indicates whether a text box accepts multiple lines of input or only a single line.
aria-multiselectable	other	Indicates that the user may select more than one item from the current selectable descendants.
aria-orientation	enum	Indicates whether the element's orientation is horizontal, vertical, or unknown/ambiguous.
aria-owns	string	Identifies an element (or elements) in order to define a visual, functional, or contextual parent/child relationship between DOM elements where the DOM hierarchy cannot be used to represent the relationship.
aria-placeholder	string	Defines a short hint (a word or short phrase) intended to aid the user with data entry when the control has no value. A hint could be a sample value or a brief description of the expected format.
aria-posinset	number	Defines an element's number or position in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-pressed	other	Indicates the current "pressed" state of toggle buttons.
aria-readonly	other	Indicates that the element is not editable, but is otherwise operable.
aria-relevant	enum	Indicates what notifications the user agent will trigger when the accessibility tree within a live region is modified.
aria-required	other	Indicates that user input is required on the element before a form may be submitted.
aria-roledescription	string	Defines a human-readable, author-localized description for the role of an element.
aria-rowcount	number	Defines the total number of rows in a table, grid, or treegrid.
aria-rowindex	number	Defines an element's row index or position with respect to the total number of rows within a table, grid, or treegrid.
aria-rowindextext	string	Defines a human readable text alternative of aria-rowindex.
aria-rowspan	number	Defines the number of rows spanned by a cell or gridcell within a table, grid, or treegrid.
aria-selected	other	Indicates the current "selected" state of various widgets.
aria-setsize	number	Defines the number of items in the current set of listitems or treeitems. Not required if all elements in the set are present in the DOM.
aria-sort	enum	Indicates if items in a table or grid are sorted in ascending or descending order.
aria-valuemax	number	Defines the maximum allowed value for a range widget.
aria-valuemin	number	Defines the minimum allowed value for a range widget.
aria-valuenow	number	Defines the current value for a range widget.
aria-valuetext	string	Defines the human readable text alternative of aria-valuenow for a range widget.
children	other	The content that displays in the notification banner.
dangerouslySetInnerHTML	other
onCopy	other
onCopyCapture	other
onCut	other
onCutCapture	other
onPaste	other
onPasteCapture	other
onCompositionEnd	other
onCompositionEndCapture	other
onCompositionStart	other
onCompositionStartCapture	other
onCompositionUpdate	other
onCompositionUpdateCapture	other
onFocus	other
onFocusCapture	other
onBlur	other
onBlurCapture	other
onChange	other
onChangeCapture	other
onBeforeInput	other
onBeforeInputCapture	other
onInput	other
onInputCapture	other
onReset	other
onResetCapture	other
onSubmit	other
onSubmitCapture	other
onInvalid	other
onInvalidCapture	other
onLoad	other
onLoadCapture	other
onError	other
onErrorCapture	other
onKeyDown	other
onKeyDownCapture	other
onKeyPress	other
onKeyPressCapture	other
onKeyUp	other
onKeyUpCapture	other
onAbort	other
onAbortCapture	other
onCanPlay	other
onCanPlayCapture	other
onCanPlayThrough	other
onCanPlayThroughCapture	other
onDurationChange	other
onDurationChangeCapture	other
onEmptied	other
onEmptiedCapture	other
onEncrypted	other
onEncryptedCapture	other
onEnded	other
onEndedCapture	other
onLoadedData	other
onLoadedDataCapture	other
onLoadedMetadata	other
onLoadedMetadataCapture	other
onLoadStart	other
onLoadStartCapture	other
onPause	other
onPauseCapture	other
onPlay	other
onPlayCapture	other
onPlaying	other
onPlayingCapture	other
onProgress	other
onProgressCapture	other
onRateChange	other
onRateChangeCapture	other
onResize	other
onResizeCapture	other
onSeeked	other
onSeekedCapture	other
onSeeking	other
onSeekingCapture	other
onStalled	other
onStalledCapture	other
onSuspend	other
onSuspendCapture	other
onTimeUpdate	other
onTimeUpdateCapture	other
onVolumeChange	other
onVolumeChangeCapture	other
onWaiting	other
onWaitingCapture	other
onAuxClick	other
onAuxClickCapture	other
onClick	other
onClickCapture	other
onContextMenu	other
onContextMenuCapture	other
onDoubleClick	other
onDoubleClickCapture	other
onDrag	other
onDragCapture	other
onDragEnd	other
onDragEndCapture	other
onDragEnter	other
onDragEnterCapture	other
onDragExit	other
onDragExitCapture	other
onDragLeave	other
onDragLeaveCapture	other
onDragOver	other
onDragOverCapture	other
onDragStart	other
onDragStartCapture	other
onDrop	other
onDropCapture	other
onMouseDown	other
onMouseDownCapture	other
onMouseEnter	other
onMouseLeave	other
onMouseMove	other
onMouseMoveCapture	other
onMouseOut	other
onMouseOutCapture	other
onMouseOver	other
onMouseOverCapture	other
onMouseUp	other
onMouseUpCapture	other
onSelect	other
onSelectCapture	other
onTouchCancel	other
onTouchCancelCapture	other
onTouchEnd	other
onTouchEndCapture	other
onTouchMove	other
onTouchMoveCapture	other
onTouchStart	other
onTouchStartCapture	other
onPointerDown	other
onPointerDownCapture	other
onPointerMove	other
onPointerMoveCapture	other
onPointerUp	other
onPointerUpCapture	other
onPointerCancel	other
onPointerCancelCapture	other
onPointerEnter	other
onPointerLeave	other
onPointerOver	other
onPointerOverCapture	other
onPointerOut	other
onPointerOutCapture	other
onGotPointerCapture	other
onGotPointerCaptureCapture	other
onLostPointerCapture	other
onLostPointerCaptureCapture	other
onScroll	other
onScrollCapture	other
onWheel	other
onWheelCapture	other
onAnimationStart	other
onAnimationStartCapture	other
onAnimationEnd	other
onAnimationEndCapture	other
onAnimationIteration	other
onAnimationIterationCapture	other
onTransitionEnd	other
onTransitionEndCapture	other
disableAutoFocus	boolean	If you set type to success, or role to alert, JavaScript moves the keyboard focus to the notification banner when the page loads. To disable this behaviour, set disableAutoFocus to true.
titleId	string	The id for the banner title, and the aria-labelledby attribute in the banner. Defaults to govuk-notification-banner-title.
type	other	The type of notification to render. You can use only the success or null values with this option. If you set type to success, the notification banner sets role to alert. JavaScript then moves the keyboard focus to the notification banner when the page loads. If you do not set type, the notification banner sets role to region.

When to use this component

A notification banner lets you tell the user about something that’s not directly relevant to the thing they’re trying to do on that page of the service. For example:

telling the user about a problem that’s affecting the service as a whole (for example, delays in processing applications because of an emergency)
telling the user about something that affects them in particular (for example, an approaching deadline they need to meet)
telling the user about the outcome of something they’ve just done on a previous page (for example, confirming that an email has been sent)

When not to use this component

Use notification banners sparingly. There’s evidence that people often miss them, and using them too often is likely to make this problem worse.

If the information is directly relevant to the thing the user is doing on that page, put the information in the main page content instead. Use inset text or warning text if it needs to stand out.

Do not:

use a notification banner to tell the user about validation errors - use an error message and error summary instead
show a notification banner and an error summary on the same page - just show the error summary

How it works

Position a notification banner immediately before the page h1. The notification banner should be the same width as the page’s other content, such as components, headings and body text. For example, if the other content takes up two-thirds of the screen on desktop devices, then the notification banner should also take up two-thirds. Read about how to lay out pages.

Use role="region" and aria-labelledby="govuk-notification-banner-title" (with id="govuk-notification-banner-title" on <govuk-notification-banner__title>) so that screen reader users can navigate to the notification banner.

Avoid showing more than one notification banner on the same page. Instead, combine the messages in a single notification banner. If the messages are too different to combine, only show the highest priority notification banner.

Notification banner headings

You can use <h3> headings in the govuk-notification-banner__content to help structure your content.

Avoid using headings for single-line notifications that do not need them.

Telling the user about a problem that affects the whole service

Use a ‘neutral’ blue notification banner if the user needs to know about a problem with the service as a whole.

For example:

in a service that lets the user register or apply for something, they might need to know that it’s taking longer than usual to process applications because of an emergency
in an account-type service, the user might need to know that the service will be down for scheduled maintenance

HTML
React

<div
  class="govuk-notification-banner"
  role="region"
  aria-labelledby="govuk-notification-banner-title"
  data-module="govuk-notification-banner"
>
  <div class="govuk-notification-banner__header">
    <h2
      class="govuk-notification-banner__title"
      id="govuk-notification-banner-title"
    >
      Important
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <p class="govuk-notification-banner__heading">
      There may be a delay in processing your
      application because of the coronavirus outbreak.
    </p>
  </div>
</div>

<NotificationBanner>
  There may be a delay in processing your application
  because of the coronavirus outbreak.
</NotificationBanner>

If your service is on GOV.UK and it’s affected by an emergency, ask your department’s content team to request a change to the service start page.

If your service is getting more demand than usual, check that you’ve set up There is a problem with the service pages and Service unavailable pages, and the wording is up to date.

Telling the user about something that’s happening elsewhere

Use a ‘neutral’ notification banner if the user needs to know about something that’s happening elsewhere in the service. For example:

in a case working system, the user might need to know that there are new cases waiting for their attention
in an account-type service, you might need to tell the user that there’s a deadline approaching or that a payment is overdue

HTML
React

<div
  class="govuk-notification-banner"
  role="region"
  aria-labelledby="govuk-notification-banner-title"
  data-module="govuk-notification-banner"
>
  <div class="govuk-notification-banner__header">
    <h2
      class="govuk-notification-banner__title"
      id="govuk-notification-banner-title"
    >
      Important
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <p class="govuk-notification-banner__heading">
      You have 7 days left to send your application.
      <a
        class="govuk-notification-banner__link"
        href="#"
      >
        View application
      </a>
      .
    </p>
  </div>
</div>

<NotificationBanner>
  <p class="govuk-notification-banner__heading">
    You have 7 days left to send your application.{" "}
    <a
      class="govuk-notification-banner__link"
      href="#"
    >
      View application
    </a>
    .
  </p>
</NotificationBanner>

Reacting to something the user has done

You can also use a notification banner to tell the user about the outcome of something they’ve just done - but they have not finished using the service, so it does not make sense to use a confirmation page.

Using a notification banner is unlikely to be the right approach in a linear service - for example, a service that lets the user register or apply for a thing. For a linear service, it will usually make sense to stick to the ‘one thing per page’ approach. Do not use a notification banner to tell users that they’ve finished using a linear service. Use a confirmation page instead.

Use the green version of the notification banner to confirm that something they’re expecting to happen has happened.

HTML
React

<div
  class="govuk-notification-banner govuk-notification-banner--success"
  role="alert"
  aria-labelledby="govuk-notification-banner-title"
  data-module="govuk-notification-banner"
>
  <div class="govuk-notification-banner__header">
    <h2
      class="govuk-notification-banner__title"
      id="govuk-notification-banner-title"
    >
      Success
    </h2>
  </div>
  <div class="govuk-notification-banner__content">
    <h3 class="govuk-notification-banner__heading">
      Training outcome recorded and trainee withdrawn
    </h3>
    <p class="govuk-body">
      Contact
      <a
        class="govuk-notification-banner__link"
        href="#"
      >
        example@department.gov.uk
      </a>
      if you think there’s a problem.
    </p>
  </div>
</div>

<NotificationBanner type="success">
  <h3 class="govuk-notification-banner__heading">
    Training outcome recorded and trainee withdrawn
  </h3>
  <p class="govuk-body">
    Contact{" "}
    <a
      class="govuk-notification-banner__link"
      href="#"
    >
      example@department.gov.uk
    </a>{" "}
    if you think there’s a problem.
  </p>
</NotificationBanner>

Since you’re using the notification banner to tell the user about the outcome of something they’ve just done, add role="alert" so focus shifts to the notification banner on page load.

Remove a green notification banner when the user moves to a new page.

To make the green version of the notification banner accessible:

use headings like ‘Success’ - so that you’re not relying on colour alone to convey meaning)
use the same heading for green notification banners within the same service - so that you’re identifying components that work in the same way consistently

Research on this component

We need more research to understand:

how common it is for users to miss important information in notification banners (including users of assistive technology, who might skip straight to the h1)
whether it’s sometimes helpful to allow users to dismiss notifications, and how to do this