> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

## Resource: showToast()

## Article: showToast()

## Article Link: https://dev.wix.com/docs/sdk/host-modules/dashboard/show-toast.md

## Article Content:

# showToast()

Displays a toast notification when invoked from a dashboard page or widget within a page.

![Dashboard Toast Success](https://wixmp-833713b177cebf373f611808.wixmp.com/images/57fb55519546f8b499fb18e610eb3ba3.gif)

Use the `config` parameter to:

- Control the toast's appearance.
- Set callback functions to run when the user sees or clicks on the toast.
- Display a clickable call-to-action that is displayed inside the toast.

Up to 3 toasts can be shown at a time. If other toasts are currently shown, requests to display toasts may be queued and the toast may not be displayed immediately.

> **Note:** Toasts won't show when previewing in the editor, but they will show on the published version of the dashboard page.

## Method Declaration

```ts
(config: ToastConfig) => { remove: () => void }
```

## Parameters

| Name     | Type                               | Description                  |
|:---------|:-----------------------------------|:-----------------------------|
| `config` | [ToastConfig](#toastconfig-object) | Toast configuration options. |

#### ToastConfig Object

| Name           | Type                        | Description                                                                                                                                                                                                     |
|:---------------|:----------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `action`       | [ToastAction](#toastaction-object) | Optional. Object representing a call-to-action that's displayed in the toast.                                                                                                                                   |
| `message`      | `string`                    | Text that appears in the toast.                                                                                                                                                                                 |
| `onCloseClick` | `Function`                  | Optional. Callback function to run when the toast is closed by clicking its close button.                                                                                                                       |
| `onToastSeen`  | `Function`                  | Optional. Callback function to run when the toast is seen by the user.                                                                                                                                          |
| `priority`     | `string`                    | Priority of the toast. If several toasts are triggered at the same time, they're displayed in the order of their priority levels. Default: `normal`. <br>Options: `low`, `normal`, `high`.                      |
| `timeout`      | `string`                    | Whether the toast should disappear after a predefined timeout (6 seconds). <br>Options: `none`, `normal`.                                                                                                       |
| `type`         | `string`                    | Toast icon and message type. Default: `standard`. <br>Options: <br>`standard`: Information icon. <br>`success`: Green checkmark icon. <br>`warning`: Yellow warning icon. <br>`error`:  Red error icon. |



#### ToastAction Object

| Name                 | Type       | Description                                                      |
|:---------------------|:-----------|:-----------------------------------------------------------------|
| `onClick`            | `Function` | Callback function to run after the call-to-action is clicked.    |
| `removeToastOnClick` | `boolean`  | Whether to remove the toast after the call-to-action is clicked. |
| `text`               | `string`   | Text that appears in the call-to-action.                         |
| `uiType`             | `string`   | The type of call-to-action. Options: `button`, `link`            |

## Returns

```ts
{ remove: () => void }
```

The object returned by `showToast` contains a method that can be used to remove the toast.

## Examples
> **Note:** To call this method in [self-hosted apps](https://dev.wix.com/docs/sdk/articles/get-started/about-self-hosted-apps.md), you need to create a [client](https://dev.wix.com/docs/sdk/articles/set-up-a-client/about-the-wix-client.md). See the [setup](https://dev.wix.com/docs/sdk/host-modules/dashboard/introduction.md) guide for more details.

### Display a success toast when a product is updated

```ts
import { dashboard } from '@wix/dashboard';

dashboard.showToast({
  message: 'Product updated successfully!',
  type: 'success',
});
```

### Display an error toast with a 'Learn more' link

```ts
import { dashboard } from '@wix/dashboard';

dashboard.showToast({
    message: 'Product update failed.',
    timeout: 'none',
    type: 'error',
    priority: 'low',
    action: {
      uiType: 'link',
      text: 'Learn more',
      removeToastOnClick: true,
      onClick: () => {
        // Logic to run when the user clicks the 'Learn more' link.
        console.log('Learn more clicked!');
      }
    }
  }
);
```

### Remove a displayed toast

```ts
import { dashboard } from '@wix/dashboard';

// Display a toast and save the remove method.
const { remove } = dashboard.showToast({
  message: 'Product updated successfully!',
  type: 'success',
  timeout: 'none',
});

// Remove the toast.
remove();
```