Contents
Commands
open
Opens the Toaster UI.
Options
| Option | Type | Description |
|---|---|---|
| type | string | Specifies the type of body content that can be provided to toaster window. Generic type shows the default body content and custom type overrides the default html body content. |
| title | string | Heading title to display on the toaster window. |
| body | string | Holds text value for Generic toaster type and html string template for Custom toaster type. |
| icon | string | The CSS class name for an icon. |
| controls | string | Show close and minimize controls on toaster window. |
| buttons | object | Define the type of buttons. |
| buttons.type | string | Shows two buttons on the toaster. |
| buttons.primary | string | Text to be shown on primary button. |
| buttons.secondary | string | Text to be shown on secondary button. |
| immutable | boolean | When set to true, toaster cannot be closed by other plugins. |
Resolutions
| Status | When | Returns |
|---|---|---|
| resolved | When Toaster is successfully opened | n/a |
| rejected | When no toaster type is specified | 'No content was provided. Toaster has ignored your command' |
| rejected | When toaster is already opened | 'Toaster view is currently reserved' |
close
Closes the Toaster UI.
Resolutions
| Status | When | Returns |
|---|---|---|
| resolved | When toaster is successfully closed. | n/a |
| rejected | When Toaster is already closed. | 'Toaster view is already closed' |
| rejected | When Toaster view is immutable. | 'Toaster view is currently reserved' |
Comments or questions about this documentation? Contact us for support!
