Skip to main content
A toast is a subtle, usually temporary, pop-up notification to let the user know that something is happening or has just happened.
These are useful to show when you are performing asynchronous actions such as loading or saving data.

​
API

TypeScript

​
Returns

A Promise that resolves to an object containing:
​
() => Promise<void>
By calling hideToast() you can imperatively hide the toast.
Useful if your toast was showing a “loading” or “saving” message.

​
Options

​
string
required
The title of the toast.
​
string
required
The text of the toast.
​
{ label: string, onClick: () => void }
An optional action button that can execute code if and when the user triggers it.
​
number
How long to keep the toast open.Defaults to 4_000 (four seconds)
If you want the toast to remain open indefinitely, you can pass Number.POSITIVE_INFINITY.
Only do this if you do not have dismissable set to false!
​
boolean
Whether or not to allow the user to dismiss the toast.Defaults to true.