For the complete documentation index, see llms.txt. This page is also available as Markdown.

Show Toast

Show a brief overlaid notification to confirm a user's action or give immediate feedback, without navigating away from the current page.

Overview

Use a toast message to confirm a user's action and provide feedback. Toasts are overlaid notifications that stack horizontally and can be dismissed by the user.

In a component's interaction Type dropdown it appears as Show Toast Notification.

Use a toast for one of these types of responses:

  • Info: Inform users that their actions have triggered a process, and they may have to wait for completion before proceeding.

  • Success: Confirm a successful or completed action.

  • Warning: Warning toasts inform users of potential issues related to their actions and guide them to prevent future problems.

  • Error: Communicate an issue preventing a user from completing their current action and can be fixed within their current flow.

In general, use a toast interaction in response to user action. To decide whether you should use Toasts or another type of messaging, jump to Toasts vs. Alert Modal vs. Confirm interaction.

Configuration

Property
Description

Title

Text that will be displayed in the header.

Message

Main content message for your alert box.

Variant

Semantic style of the toast: Info (the default), Success, Warning or Error.

Mode

Determines how persistent the toast is. Choose between Dismissible (the default), Pester and Sticky.

Mode definition

  • Dismissible

    • Description: Toasts with the Dismissible mode appears for a short period and then automatically fades away. Users also have the option to dismiss the toast earlier by clicking on it or the close button.

    • Usage: Use this mode for informative messages that are not critical to the user's workflow, allowing them to disappear without requiring user action, thus maintaining a smooth user experience.

    Pester

    • Description: The Pester mode keeps the toast on-screen for a longer duration compared to Dismissible, but it will eventually close after a set time. It does not require immediate attention and allows the user to continue their work, but it persists longer to ensure the user has ample time to read the message.

    • Usage: This mode is best for notifications that hold moderate importance, where you want to ensure that the user has seen the message but it is not urgent enough to interrupt their current task.

    Sticky

    • Description: Toasts set to Sticky mode will remain on the screen indefinitely until the user takes action to dismiss them. They will not fade away automatically.

    • Usage: Reserve Sticky mode for critical alerts that require user attention or action before proceeding. These messages are crucial and should stay in view until the user acknowledges them, ensuring the message has been noticed.

Example

Imagine a community page where members save a preference from an Avonni Button:

  1. On the button's On Click, set the interaction Type to Show Toast Notification.

  2. Set the Title to "Preferences saved" and leave the Message empty — the title alone carries it.

  3. Pick the Success Variant so the toast reads as a confirmation.

  4. Leave Mode on Dismissible so the toast fades on its own without the member having to close it.

Chain it after the interaction that does the work — for example as the On Finish step of an Open Flow Dialog — so the toast only fires once the save actually succeeds.

Last updated

Was this helpful?