Get to know our frameworks

Select an app template built on your preferred framework.

Build apps on our native app editor. Use drag and drop elements, Velo code and Wix APIs to develop custom features.

Streamline your app development process with the Wix CLI. Get a familiar developer experience with minimal setup and configuration.

Take full control over your app's tech stack, deployment, and hosting.

App templates

Wix Blocks templates

Wix CLI templates

Self-hosted templates

Kickstart your app development with templates built on your preferred Wix developer tool. Browse templates for practical foundation and get to know the Wix ecosystem.

Wix App Templates for Developers

This example apps can be used as a starting point for building your own app, for concrete examples of how to use Wix framework, or for inspiration.

Choose a template.<0 />Build an app.

Browse by:

How to build it step by step:

This template is built with:

Read how this template was built, step by step.

How we built this template

Deployment instructions:

Choose a package manager and run the command in your terminal.

Copy command

Before you get started, make sure you have the following:

Prerequisite steps

Get started with Wix CLI

Begin by setting up your Next.js project with your preferred hosting platform.

Select your hosting service

Start the deployment flow and set up your template repo on Netlify. After you finish set up, come back here and add your Netlify custom domain.

Copy the code from our Git repo to deploy your app on any platform that supports Next.js.

Start the deployment flow and set up your template repo on Vercel. After you finish set up, come back here and add your Vercel generated URL.

Add the base URL and give your app a name.

App details

Go to the app dashboard and test your app to ensure a smooth integration within the Wix ecosystem. <0>Learn more about app checks and testing</0>

Define your environment

Terminal

Related templates

Note

Warning

Your app name will be used as the namespace suffix.

Name your app to generate a namespace. This lets you refer to your app in code later on.

Go Headless

Build Apps

Client

API Preview

Ricos

Develop Websites

REST

Velo

GraphQL (Alpha)

# 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/show-toast-md_js-sdk-docs_dashboard_assets_dashboard-toast-success.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.

Only one toast can be shown at a time. Requests to display toasts may be queued and the toast may not be displayed immediately, if another toast is currently shown.

> **Note:** When the `timeout` parameter is set to `none` (a toast that the user needs to close manually, or removed via code) the toast is rendered into the page layout and pushes the rest of the page down. When `timeout` is set to `normal`, the toast appears on top of other content on the page.

## Signature

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

## Parameters

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

#### ToastConfig Object

| Name | Type | Description |
|:---------------|:----------------------------|:----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `action` | [ToastAction](fallback::#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`. Options: `low`, `normal`, `high`. |
| `timeout` | `string` | Whether the toast should disappear after a predefined timeout (6 seconds). Options: `none`, `normal`. |
| `type` | `string` | Toast color and message type. Default: `standard`. Options: `standard`: Blue notification toast. `success`: Green success toast. `warning`: Yellow warning toast. `error`: Red error toast. |

#### 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 function that can be used to remove the toast.

## Examples
To set up a dashboard client, refer to the [setup](resourceId::b5088d52-82f9-44cc-b1a2-fea83606d85d#setup*fallback::https://github.com/wix-private/developer-docs/blob/e37db2c065a91ebbddb6bc8dfc932b5d4fd9db20/js-sdk-docs/dashboard/intro.md#setup*original::./intro.md#setup) guide.

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

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

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

```ts
client.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
// Display a toast and save the remove function.
const { remove } = client.dashboard.showToast({
 message: 'Product updated successfully!',
 type: 'success',
 timeout: 'none',
});

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

名称	タイプ	説明
`action`	ToastAction	Optional. Object representing a call-to-action that's displayed in the toast.
`メッセージ`	`ストリング`	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`	`ストリング`	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`. Options: `low`, `normal`, `high`.
`timeout`	`ストリング`	Whether the toast should disappear after a predefined timeout (6 seconds). Options: `none`, `normal`.
`タイプ`	`ストリング`	Toast color and message type. Default: `standard`. Options: `standard`: Blue notification toast. `success`: Green success toast. `warning`: Yellow warning toast. `error`: Red error toast.

名称	タイプ	説明
`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 that appears in the call-to-action.
`uiType`	`ストリング`	The type of call-to-action. Options: `button`, `link`

showToast

署名

Parameters

ToastConfig Object

ToastAction Object

リターン

例

Display a success toast when a product is updated

Display an error toast with a 'Learn more' link

Remove a displayed toast