Docker Extension API: Toast Interface

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

e6aeebe867d318de2053fd16f57f3c4822023ecd06d0c4d90000000300000581

---
title: "Interface: Toast"
description: Docker extension API reference
keywords: Docker, extensions, sdk, API, reference
aliases:
 - /desktop/extensions-sdk/dev/api/reference/interfaces/Toast/
 - /extensions/extensions-sdk/dev/api/reference/interfaces/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.

```typescript
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.

```typescript
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.

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

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `msg` | `string` | The message to display in the toast. |

#### Returns

`void`

Chunks

d227c9f6 (1st chunk of `content/reference/api/extensions-sdk/Toast.md`)

Title: Docker Extension API: Toast Interface

Summary

This section of the Docker Extension API documentation describes the `Toast` interface, which allows extensions to display brief, non-intrusive notifications to the user. It details the `success`, `warning`, and `error` methods for displaying toast messages with corresponding severity levels.