Toast
Availability
This feature will be available with Shopware 6.6.2.0.
Dispatch a toast
Usage:
function alertYes() {
alert('Yes');
}
sw.toast.dispatch({
msg: 'Your message',
dismissible: true,
type: 'positive',
action: {
label: 'action',
callback: alertYes
},
})
Parameters:
Name | Required | Default | Description |
---|---|---|---|
msg | true | Defines a toast's main expression or message to the user. | |
type | true | Defines the toast type. Available types are positive , informal and critical . | |
icon | false | None | A icon that should be displayed in front of your message. |
dismissible | false | false | Specifies if the toast can be manually dismmissed. |
action | false | None | Adds a clickable button to the toast. The button receives a label and a callback wichs is called once clicked. |
Return value:
Returns a promise without data.