docker-docs/content/reference/api/extensions-sdk/Toast.md

description, keywords, aliases

description	keywords	aliases
Docker extension API reference	Docker, extensions, sdk, API, reference	/desktop/extensions-sdk/dev/api/reference/interfaces/Toast/ /extensions/extensions-sdk/dev/api/reference/interfaces/Toast/

Interface: Toast

Toasts provide a brief notification to the user. They appear temporarily and shouldn't interrupt the user experience. They also don't require user input to disappear.

Since

0.2.0

Methods

success

▸ success(msg): void

Display a toast message of type success.

ddClient.desktopUI.toast.success("message");

Parameters

Name	Type	Description
msg	string	The message to display in the toast.

Returns

void

---

warning

▸ warning(msg): void

Display a toast message of type warning.

ddClient.desktopUI.toast.warning("message");

Parameters

Name	Type	Description
msg	string	The message to display in the warning.

Returns

void

---

error

▸ error(msg): void

Display a toast message of type error.

ddClient.desktopUI.toast.error("message");

Parameters

Name	Type	Description
msg	string	The message to display in the toast.

Returns

void