Toast
  • 18 May 2022
  • 1 Minute to read
  • Dark
    Light
  • PDF

Toast

  • Dark
    Light
  • PDF

Shows a non-blocking toast dialog with the given message. The dialog will disappear automatically, unless otherwise configured.

Input arguments

Label Key Type Required? Default Description
Toast message message Json Yes Message to show on the toast dialog.
Show duration duration Number No 2000 The duration how long the toast will be shown, in millliseconds. Leave empty to show it indefinitely.
Toast position position Number No -20

The position of toast showing on screen.

A negative number represents the distance from the bottom of screen.

A positive number represents the distance form the top of screen.

0 will position the toast to the middle of screen.

Animates? animation Boolean No true Determines if the toast appears and disappears with a fade animation.
Has shadow? shadow Boolean No true Determines if the toast dialog has a drop shadow around it.
Background color backgroundColor String No rgb(0, 0, 0) Background color for the toast dialog.
Shadow color shadowColor String No rgb(0, 0, 0) Color of the toast dialog's shadow.
Text color textColor String No rgb(255, 255, 255) Text color for the toast dialog.
Dismiss toast when pressed? hideOnPress Boolean No true Determines if the user can dismiss the toast dialog by pressing on it.
Toast opacity opacity Number No 0.8 Opacity for the toast dialog. Must be between `0…1`.

Output arguments

Number of outputs: undefined

No output arguments.

Events

No events.

Errors

No errors.


Was this article helpful?

What's Next