Toast
When an asynchronous operation is happening or when an error is thrown, it's usually a good idea to keep the user informed about it. Toasts are made for that.
Additionally, Toasts can have some actions associated to the action they are about. For example, you could provide a way to cancel an asynchronous operation, undo an action, or copy the stack trace of an error.
API Reference
showToast
Creates and shows a Toast with the given options.
Signature
Example
When showing an animated Toast, you can later on update it:
Parameters
Name | Description | Type |
---|---|---|
options* | The options to customize the Toast. |
Return
A Promise that resolves with the shown Toast. The Toast can be used to change or hide it.
Types
Toast
A Toast with a certain style, title, and message.
Use showToast to create and show a Toast.
Properties
Property | Description | Type |
---|---|---|
message* | An additional message for the Toast. Useful to show more information, e.g. an identifier of a newly created asset. |
|
primaryAction* | The primary Action the user can take when hovering on the Toast. | |
secondaryAction* | The secondary Action the user can take when hovering on the Toast. | |
style* | The style of a Toast. | |
title* | The title of a Toast. Displayed on the top. |
|
Methods
Name | Type | Description |
---|---|---|
hide |
| Hides the Toast. |
show |
| Shows the Toast. |
Toast.Options
The options to create a Toast.
Example
Properties
Property | Description | Type |
---|---|---|
title* | The title of a Toast. Displayed on the top. |
|
message | An additional message for the Toast. Useful to show more information, e.g. an identifier of a newly created asset. |
|
primaryAction | The primary Action the user can take when hovering on the Toast. | |
secondaryAction | The secondary Action the user can take when hovering on the Toast. | |
style | The style of a Toast. |
Toast.Style
Defines the visual style of the Toast.
Use Toast.Style.Success for confirmations and Toast.Style.Failure for displaying errors. Use Toast.Style.Animated when your Toast should be shown until a process is completed. You can hide it later by using Toast.hide or update the properties of an existing Toast.
Enumeration members
Name | Value |
---|---|
Animated | |
Success | |
Failure |
Toast.ActionOptions
The options to create a Toast Action.
Properties
Property | Description | Type |
---|---|---|
title* | The title of the action. |
|
onAction* | A callback called when the action is triggered. |
|
shortcut | The keyboard shortcut for the action. |
Last updated