Toast GroupReady
Toast group is used to position and style a group of toasts, whilst ensuring they are announced by screen readers.
<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>Events
| Event | Description | Type |
|---|---|---|
dismiss | Fired when a 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 name | Description |
|---|---|
| Default slot | Default slot in which to place toasts. |
Methods
| Method name | Parameters | Description |
|---|---|---|
addToast(text: string, options: ToastOptions) => Toast | text: The text/message of the toast.options: An optional object for configuring the toast's `variant` and `autoDismiss`. | Convenience method for creating and adding a toast to the group. |
Dependencies
This component is internally dependent on the following components:
Usage
This section includes guidelines for designers and developers about the usage of this component in different contexts.
Do
- Use in combination with Toast so that toasts get styled and announced to screen readers correctly.
- Add as close to the bottom of the document as possible, ideally near the body closing tag, to maintain correct stacking order.
Don’t
- Don’t use for grouping anything other than toast components
Content guidelines
Toast content should be clear, accurate and understandable by the user:
When writing the toast content, use the {noun} + {verb} content formula:
Use a maximum of 3 words when writing the toast content:
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):
Avoid unnecessary words and articles in the toast content, such as “the”, “an” or “a”:
Never end in punctuation:
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.
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.