Active theme set to LightDarkLight high contrastDark high contrast and saved in preferences.
Copied to clipboard.
Error submitting your feedback! Please try again.

ToastNew

Toasts are non-disruptive messages that appear in the interface to provide quick, at-a-glance feedback on the outcome of an action.

Edit in CodePen
Open in new window
Edit in CodePen
Open in new window
View RTL
<nord-button variant="primary">Add toast</nord-button>

<nord-toast-group>
<nord-toast>Message sent</nord-toast>
</nord-toast-group>

<script>
// clean up toasts once they are dismissed
const group = document.querySelector("nord-toast-group")
group.addEventListener("dismiss", e => e.target.remove())

// add toasts on click for demo purposes
const button = document.querySelector("nord-button")
button.addEventListener("click", () => group.addToast("Message sent"))
</script>

Properties

PropertyAttributeDescriptionTypeDefault
variantvariant

The style variant of the toast.

"default" | "danger""default"
autoDismissauto-dismiss

Timeout in milliseconds before the toast is automatically dismissed.

number10000

Events

EventDescriptionType
dismiss

Fired when the toast is dismissed (via user action or auto-dismiss), and its exit animation has completed. This event should be used to remove the dismissed toast from the DOM.

NordEvent

Slots

Slot nameDescription
Default slotDefault slot used for the toast text/message.

Methods

Method nameParametersDescription
dismiss() => voidN/AProgrammatically dismiss the toast. The returned promise resolves when toast's exit animation is complete.

Usage #

This section includes guidelines for designers and developers about the usage of this component in different contexts.

Do #

  • Use for short messages that confirm an action taken by a user.
  • Use for ephemeral status updates.
  • Use in combination with Toast group so that toasts get styled and announced to screen readers correctly.

Don’t #

  • Don’t use toasts for critical information that user needs to act on.
  • Don’t rely on users seeing toasts. Toasts are transient and should not be used for critical messages.
  • Don’t place interactive content in toasts. Assistive technology like screen readers will not convey any semantics when announcing toast messages.
  • Don’t use for error messages unless absolutely necessary. Try to favor a Banner for error messaging instead.

Content guidelines #

Toast content should be clear, accurate and easy to understand:

Message sent
Your message has been sent

When writing the toast content, use the {noun} + {verb} content formula:

Patient created
Your patient has been successfully updated

Use a maximum of 3 words when writing the toast content:

Product updated
Your product was updated just now

When writing the toast content, always write it in sentence case, not title case. The first word should be capitalized and the rest lowercase (unless a proper noun):

Message sent
Message Sent

Avoid unnecessary words and articles in the toast content, such as “the”, “an” or “a”:

Changes saved
The changes were saved

Never end in punctuation:

Message sent
Message sent.

Additional considerations #

  • Toasts are complicated from an accessibility perspective. Whilst they are a convenient UI pattern for messaging, they present difficulties for keyboard or screen reader users. Therefore careful consideration should be given as to whether a toast is the correct choice.
  • If the message cannot be conveyed in 3 words or less, consider re-wording. If the message cannot be shortened any further, consider choosing a different pattern than toast.

Integration

For integration guidelines, please see Web Components documentation. This documentation explains how to implement and use Nord Web Components across different technologies such as Vue.js, React, or Vanilla JavaScript.

Integration Guidelines

Localization

Nord provides a lightweight solution for localizing its components. Not all components need localizing, as for the most part snippets of text are set per instance. For full localization guidelines, please see Localization documentation.

Localization Guidelines

Troubleshooting

If you experience any issues while using Nord Web Components, please head over to the Support page for more guidelines and ways to contact us.


Was this page helpful?

YesNo
Send feedback

We use this feedback to improve our documentation.