Toast

The toast component is a non-disruptive message that appears at the bottom of the interface to provide quick, at-a-glance feedback on the outcome of an action.

Examples

Use to convey general confirmation or actions that aren’t critical. For example, you might show a toast message to inform the merchant that their recent action was successful.

Drag to resize example

Props

action
Action
Adds an action next to the message (stand-alone app use only)
contentRequired
string
The content that should appear in the toast message
duration
number
The length of time in milliseconds the toast message should persist
error
boolean
Display an error toast.
onDismissRequired
() => void
Callback when the dismiss icon is clicked

Accessibility

The content of the toast component is implemented as an ARIA live region using aria-live="polite". When the toast appears, screen readers should announce the toast text after any other more pressing announcements.

Avoid using toast for critical information that merchants need to act on immediately. Toast might be difficult for merchants with low vision or low dexterity to access because it:

  • Disappears automatically
  • Can’t be easily accessed with the keyboard
  • Might appear outside the proximity of the merchant’s current focus

Toast with action

Make sure that merchants can also accomplish the action in the toast another way, since the toast action may be difficult to access for some merchants. If the toast action is not available somewhere else on the page, for example a retry action that reloads a section, it should have a fallback action, for example a browser refresh.

Toast with action should persist for at least 10,000 milliseconds to give the merchant enough time to act on it.

Default toast

Use default toast for informative and neutral feedback.

Default toast with neutral color

Success toast

Use success toast to indicate that something was successful. For example, a product was successfully updated.

Success toast

Error toast

Although error toast is still available and used in the system, we discourage its use. Reserve it for errors not caused by merchants, like a connection issue. Error toast should convey what went wrong in plain language and should not go over 3 words. For all other error message types, follow the error message guidelines.

Error toast

With action

Use action when merchants have the ability to act on the message. For example, to undo a change or retry an action. Keep the action label short, preferably 1 verb action.

Default toast with action to undo

Default toast

Use default toast for informative and neutral feedback.

On iOS, icons are available for cases where you want to re-inforce the message.

Default toast with neutral color

Success toast

Use success toast to indicate that something was successful. For example, a product was successfully updated.

On iOS, icons are available for cases where you want to re-inforce the message.

Success toast

Error toast

Although error toast is still available and used in the system, we discourage its use. Reserve it for errors not caused by merchants, like a connection issue. Error toast should convey what went wrong in plain language and should not go over 3 words. For all other error message types, follow the error message guidelines.

On iOS, icons are available for cases where you want to re-inforce the message.

Error toast

With action

Use action when merchants have the ability to act on the message. For example, to undo a change or retry an action. Keep the action label short, preferably 1 verb action.

Default toast with action to undo

Required components

The toast component must be wrapped in the frame component or used in an embedded application.


Use in an embedded application (deprecated)

Passing an API key to the app provider component causes the toast component to delegate to the Shopify App Bridge instead of rendering as it would in a stand-alone application.

Note that when used in an embedded application, the toast component does not support multiple, simultaneous toast messages.

class EmbeddedAppToastExample extends React.Component {
  state = {
    showToast: false,
  };

  render() {
    const toastMarkup = this.state.showToast && (
      <Toast
        content="Message sent"
        onDismiss={() => this.setState({showToast: false})}
      />
    );

    return <AppProvider apiKey="YOUR_API_KEY">{toastMarkup}</AppProvider>;
  }
}

Deprecation rationale

As of v3.17.0, using Toast in an embedded app is deprecated. Support for this will be removed in v5.0 as the underlying Shopify App Bridge library will be removed from Polaris React. Learn more about the deprecation rationale. Use Toast from @shopify/app-bridge-react instead.


Best practices

Toast should:

  • Be used for short messages to confirm an action
  • Not go over 3 words
  • Rarely be used for error messages

When to use:

  • For success messages
  • Only for non-critical errors that are relevant in the moment and can be explained in 3 words. For example, if there’s an internet connection issue, the toast would say, Internet disconnected.

When not to use:

  • Avoid using toast for error messages. Always try to use a banner to prominently inform merchants about persistent errors.

Content guidelines

Message

Toast messages should be:

  • Short and affirmative
  • Written in the pattern of: noun + verb
  • Product updated

  • Collection added

  • Customer updated

  • Internet disconnected

  • Connection timed out

  • No internet connection

  • Can’t charge negative tax rates

  • Your online store has a maximum of 20 themes. Delete unused themes to add more.

  • Your product has been successfully updated

  • We were unable to save the customer

  • Your Order was Archived Today

  • Discount: Saved successfully

Toast with action

Only include an action in toast if the same action is available elsewhere on the page. For example:

  • If merchants need to reload a section, offer the call to action [Reload] in the toast. If they miss the toast message, they can also refresh the entire page.
  • If merchants delete an image, offer the option to [Undo] the deletion. If they miss it in the toast message, they can still retrieve it from somewhere else.

Action should:

  • Keep the action label short, preferably 1 verb.
  • Not have actions, like [Cancel], for dismissing toast. The [X] to dismiss is already included in the component.
  • Be used with a duration of at least 10,000 milliseconds for accessibility.
  • Undo

  • Change

  • Edit

  • View

  • Retry

  • OK

  • Got it

  • Cancel product

  • Continue to collection

  • Dismiss