Skip to main content

Notices deliver System and Engagement messaging, informing the user about product or account statuses and related actions.

Class Parent Modifies Description
.s-notice .s-toast when rendered as a toast N/A Base notice parent class.
.s-notice--actions .s-notice N/A Container styling for notice actions including the dismiss button.
.s-notice--dismiss .s-notice N/A Applies to child button element within the notice to position it appropriately.
.s-notice__activity N/A .s-notice Applies activity (pink) visual styles.
.s-notice__danger N/A .s-notice Applies danger (red) visual styles.
.s-notice__featured N/A .s-notice Applies featured (purple) visual styles.
.s-notice__important N/A .s-notice Applies an important visual style. This should be used for time-sensitive, pressing information that needs to be noticed by the user.
.s-notice__info N/A .s-notice Applies info (blue) visual styles.
.s-notice__success N/A .s-notice Applies success (green) visual styles.
.s-notice__warning N/A .s-notice Applies warning (yellow) visual styles.
.s-toast N/A N/A Parent of .s-notice. See the Toast section for more information.
Item Modifies Description
aria-labelledby="[id]" .s-toast Used to reference the alert message within the dialog. If you are using .s-toast, this must be applied.
aria-hidden="[state]" .s-toast Informs assistive technologies (such as screen readers) if they should ignore the element. When applied to .s-toast, Stacks will use this attribute to show or hide the toast.
aria-label="[text]" .s-btn Labels the element for assistive technologies (such as screen readers). This should be used on any button that does not contain text content.
role="alert" .s-notice A form of live region which contains important, usually time-sensitive, information. Elements with an alert role have an implicit aria-live value of assertive and implicit aria-atomic value of true.
role="alertdialog" .s-toast The wrapping content area of an alert. Elements with the alertdialog role must use the aria-describedby attribute to reference the alert message within the dialog.
role="status" .s-notice A form of live region which contains advisory information but isn't important enough to justify an alert role. Elements with a status role have an implicit aria-live value of polite and implicit aria-atomic value of true. If the element controlling the status appears in a different area of the page, you must make the relationship explicit with the aria-controls attribute.
<div class="s-notice" role="status">
<span class="s-notice--icon">@Svg.Help</span>
<span></span>
</div>
<div class="s-notice s-notice__info" role="status">
<span class="s-notice--icon">@Svg.Info</span>
<span></span>
</div>
<div class="s-notice s-notice__success" role="status">
<span class="s-notice--icon">@Svg.Check</span>
<span><a href="…"></a></span>
</div>
<div class="s-notice s-notice__warning" role="status">
<span class="s-notice--icon">@Svg.Alert</span>
<span></span>
</div>
<div class="s-notice s-notice__danger" role="status">
<span class="s-notice--icon">@Svg.AlertFill</span>
<span></span>
</div>
<div class="s-notice s-notice__featured" role="status">
<span class="s-notice--icon">@Svg.Star</span>
<span></span>
</div>
<div class="s-notice s-notice__activity" role="status">
<span class="s-notice--icon">@Svg.Notification</span>
<span></span>
</div>

Used sparingly for when an important notice needs to be noticed

<div class="s-notice s-notice__important" role="alert">
<span class="s-notice--icon">@Svg.Help</span>
<span></span>
</div>
<div class="s-notice s-notice__info s-notice__important" role="alert">
<span class="s-notice--icon">@Svg.Info</span>
<span></span>
</div>
<div class="s-notice s-notice__success s-notice__important" role="alert">
<span class="s-notice--icon">@Svg.Info</span>
<span><a href="…"></a></span>
</div>
<div class="s-notice s-notice__warning s-notice__important" role="alert">
<span class="s-notice--icon">@Svg.Alert</span>
<span></span>
</div>
<div class="s-notice s-notice__danger s-notice__important" role="alert">
<span class="s-notice--icon">@Svg.AlertFill</span>
<span></span>
</div>
<div class="s-notice s-notice__featured s-notice__important" role="alert">
<span class="s-notice--icon">@Svg.Star</span>
<span></span>
</div>
<div class="s-notice s-notice__activity s-notice__important" role="alert">
<span class="s-notice--icon">@Svg.Notification</span>
<span></span>
</div>

We recommend using descendent anchor classes, typically .s-anchors.s-anchors__inherit.s-anchors__underlined for notices containing links generated from markdown when you cannot manually generate the inner html.

<div class="s-notice s-notice__info" role="presentation">
<span>Notice with <a href="#" class="s-link">default link style</a></span>
</div>
<div class="s-notice s-notice__info s-anchors s-anchors__inherit s-anchors__underlined" role="presentation">
<span>Notice with <a href="#">custom link style</a></span>
</div>
We are phasing out Toasts due to significant accessibility barriers. Avoid this component for new features. Instead, prioritize integrated alternatives—such as component state changes or inline messages—to provide accessible feedback directly where the user is focused.

Toasts are floating notices that are aligned to the center top of the page. They disappear after a set time. Visibility is changed with animation by toggling between aria-hidden="true" and aria-hidden="false". When including a dismiss button the .s-notice--dismiss class should be applied to the button for toast-specific styling.

<div
role="alertdialog"
id="example-toast"
class="s-toast"
aria-hidden="true"
aria-labelledby="toast-message"
data-controller="s-toast"
data-s-toast-target="toast"
data-s-toast-return-element=".js-example-toast-open[data-target='#example-toast']">

<aside class="s-notice d-flex wmn4">
<span class="s-notice--icon">@Svg.Info</span>
<span>Toast notice message with an undo button</span>
<div class="s-notice--actions">
<button type="button" class="s-link s-link__underlined">Undo</button>
<button type="button" class="s-link s-notice--dismiss js-toast-close" aria-label="Dismiss">@Svg.Cross</button>
</div>
</aside>
</div>
Attribute Modifies Description
data-controller="s-toast" Controller element Wires up the element to the toast controller. This may be a .s-toast element or a wrapper element.
data-s-toast-target="toast" Controller element Wires up the element that is to be shown/hidden
data-s-toast-target="initialFocus" Any child focusable element Designates which element to focus on toast show. If absent, defaults to the first focusable element within the toast.
data-action="s-toast#toggle" Toggling element Wires up the element to toggle the visibility of a toast
data-s-toast-return-element="[css selector]" Controller element (optional) Designates the element to return focus to when the toast is closed. If left unset, focus is not altered on close.
data-s-toast-remove-when-hidden="true" Controller element (optional) Removes the toast from the DOM entirely when it is hidden
Event Modifies Description
s-toast:show Toast target Fires immediately before showing the toast. Calling .preventDefault() cancels the display of the toast.
s-toast:shown Toast target Fires after the toast has been visually shown
s-toast:hide Toast target Fires immediately before hiding the toast. Calling .preventDefault() cancels the removal of the toast.
s-toast:hidden Toast target Fires after the toast has been visually hidden
event.detail Applicable events Description
dispatcher s-toast:* Contains the Element that initiated the event. For instance, the button clicked to show, the element clicked outside the toast that caused it to hide, etc.
returnElement s-toast:show,
s-toast:hide
Contains the Element to return focus to on hide. If a value is set to this property inside an event listener, it will be updated on the controller as well.

The following helpers are available to manually show and hide a toast notice.

Function Parameters Description
Stacks.showToast element Helper to manually show an s-toast element via external JS
Stacks.hideToast element Helper to manually hide an s-toast element via external JS
How’d we do?
Anonymously upvote, downvote, or send additional feedback below.
Deploys by Netlify