Sonner for Vue

[![NPM][npmBadge]][npmUrl]
[![Minzip Package][bundlePhobiaBadge]][bundlePhobiaUrl]
[![NPM Download][npmDtBadge]][npmDtUrl]

[npmBadge]: https://img.shields.io/npm/v/vue-sonner.svg?maxAge=2592000
[npmUrl]: https://www.npmjs.com/package/vue-sonner
[npmDtBadge]: https://img.shields.io/npm/dt/vue-sonner.svg
[npmDtUrl]: https://www.npmjs.com/package/vue-sonner
[bundlePhobiaBadge]: https://img.shields.io/bundlephobia/minzip/vue-sonner
[bundlePhobiaUrl]: https://bundlephobia.com/package/vue-sonner@latest

> An opinionated toast component for Vue. It's a Vue port of Sonner

Preview

https://user-images.githubusercontent.com/6118824/228208185-be5aefd4-7fa8-4f95-a41c-88a60c0e2800.mp4

Introduction

Vue Sonner is an opinionated toast component for Vue. It's customizable, but styled by default. Comes with a swipe to dismiss animation.

Table of Contents

Installation

To start using the library, install it in your project:

``bash
pnpm install vue-sonner
or
yarn add vue-sonner
`

Test

To run the test you need two separate CLI window :

$3

To launch the test, you need to go in the test directory

`bash
cd ./test
`

and launch the following command

`bash
cd ./test
pnpm test:e2e --ui
`

$3

This command will build the vue-sonner library in lib mode, and add a watch so every time you modify the code of the library, you will have a new bundle and can run the test again.

`bash
pnpm build:dev
`

Usage

$3

`html




`

$3

Use vue-sonner/nuxt module

`ts
// nuxt.config.ts
export default defineNuxtConfig({
...
modules: ['vue-sonner/nuxt']
vueSonner: {
css: false // true by default to include css file
}
})
`

Use Toaster component and $toast function anywhere in the Vue SFC

`html




`

$3

EMS version

`ts
https://cdn.jsdelivr.net/npm/vue-sonner/+esm
`

Types

$3

Most basic toast. You can customize it (and any other type) by passing an options object as the second argument.

`ts
toast('Event has been created')
`

With custom description:

`ts
toast('Event has been created', {
description: 'Monday, January 3rd at 6:00pm'
})
`

$3

Renders a checkmark icon in front of the message.

`ts
toast.success('Event has been created')
`

$3

Renders an error icon in front of the message.

`ts
toast.error('Event has not been created')
`

$3

Renders a button.

`ts
toast('Event has been created', {
action: {
label: 'Undo',
onClick: () => console.log('Undo')
}
})
`

$3

Starts in a loading state and will update automatically after the promise resolves or fails.

You can pass a function to the success/error messages to incorporate the result/error of the promise.

`ts
toast.promise(() => new Promise((resolve) => setTimeout(resolve, 2000)), {
loading: 'Loading',
success: (data: any) => 'Success',
error: (data: any) => 'Error'
})
`

$3

You can pass a Vue Component as the first argument instead of a string to render custom Component while maintaining default styling. You can use the headless version below for a custom, unstyled toast.

`html

`

Customization

$3

You can use toast.custom to render an unstyled toast with custom jsx while maintaining the functionality.

`vue

`

$3

You can change the theme using the theme prop. Default theme is light.

`html

`

$3

You can change the position through the position prop on the component. Default is top-right.

`html




`

$3

Toasts can also be expanded by default through the expand prop. You can also change the amount of visible toasts which is 3 by default.

`html

`

$3

You can style your toasts globally with the toastOptions prop in the Toaster component.

`html
:toastOptions="{
style: { background: 'red' },
class: 'my-toast',
descriptionClass: 'my-toast-description'
}"
/>
`

$3

`ts
toast('Event has been created', {
style: {
background: 'red'
},
class: 'my-toast',
descriptionClass: 'my-toast-description'
})
`

$3

The preferred way to style the toasts with tailwind is by using the unstyled prop. That will give you an unstyled toast which you can then style with tailwind.

`vue
:toastOptions="{
unstyled: true,
classes: {
toast: 'bg-blue-400',
title: 'text-red-400',
description: 'text-red-400',
actionButton: 'bg-zinc-400',
cancelButton: 'bg-orange-400',
closeButton: 'bg-lime-400'
}
}"
/>
`

You can do the same when calling toast().

`ts
toast('Hello World', {
unstyled: true,
classes: {
toast: 'bg-blue-400',
title: 'text-red-400 text-2xl',
description: 'text-red-400',
actionButton: 'bg-zinc-400',
cancelButton: 'bg-orange-400',
closeButton: 'bg-lime-400'
}
})
`

Styling per toast type is also possible.

`vue
:toastOptions="{
unstyled: true,
classes: {
error: 'bg-red-400',
success: 'text-green-400',
warning: 'text-yellow-400',
info: 'bg-blue-400'
}
}"
/>
`

$3

You can change the default icons using slots:

`vue







`

$3

Add a close button to all toasts that shows on hover by adding the closeButton prop.

`html

`

$3

You can make error and success state more colorful by adding the richColors prop.

`html

`

$3

Offset from the edges of the screen.

`html

`

$3

You can pass onDismiss and onAutoClose callbacks. onDismiss gets fired when either the close button gets clicked or the toast is swiped. onAutoClose fires when the toast disappears automatically after it's timeout (duration prop).

`ts
toast('Event has been created', {
onDismiss: (t) => console.log(Toast with id ${t.id} has been dismissed),
onAutoClose: (t) =>
console.log(Toast with id ${t.id} has been closed automatically)
})
`

$3

You can change the duration of each toast by using the duration property, or change the duration of all toasts like this:

`html

`

`ts
toast('Event has been created', {
duration: 10000
})

If you want a toast to stay on screen forever, you can set the duration to Infinity.

// Persisent toast
toast('Event has been created', {
duration: Infinity
})
`

$3

To remove a toast programmatically use toast.dismiss(id).

`ts
const toastId = toast('Event has been created')

toast.dismiss(toastId)
`

You can also dismiss all toasts at once by calling toast.dismiss() without an id.

`ts
toast.dismiss()
`

$3

You can focus on the toast area by pressing ⌥/alt + T. You can override it by providing an array of event.code values for each key.

`html

``

Contributors

Inspiration

- sonner - An opinionated toast component for React.

License

MIT @xiaoluoboding