@neoncoder/vuetify-sonner

https://github.com/wobsoriano/vuetify-sonner/assets/13049130/3dc381ec-95b2-4bd1-9df6-624210e9d9f4

vuetify-sonner

Stackable toast component for Vuetify.

[!IMPORTANT] Snackbars should appear one at a time. This component breaks the Material spec.

Installation

npm install vuetify-sonner

Usage

Add <VSonner /> to your app, it will be the place where all your toasts will be rendered. After that you can use toast() from anywhere in your app.

<script setup lang="ts">
import { VSonner, toast } from 'vuetify-sonner'
// Required for snackbar background and text color
import 'vuetify-sonner/style.css'
</script>

<template>
  <VApp>
    <VSonner />
    <VBtn @click="toast('My first toast')">
      Give me a toast
    </VBtn>
  </VApp>
</template>

Default

Most basic toast. You can customize it by passing an options object as the second argument.

toast('My first toast')

With description:

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

Action

Renders a button.

toast('Event has been created', {
  action: {
    label: 'Undo',
    onClick: () => console.log('Undo'),
    buttonProps: {
      // v-btn props
    }
  },
})

Customization

Behind the scenes, the toast component uses Vuetify Cards, as the snackbar component has its own overlay logic.

Position

You can change the position through the position prop on the <VSonner /> component. Default is bottom-center.

<VSonner position="top-center" />

Expanded

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.

<VSonner expand :visible-toasts="9" />

Toast Options

toast('Event has been created', {
  description: 'Some more context of the notification' // subtitle of the snackbar
  cardProps: {
    color: 'success',
    class: 'my-toast',
    // v-card props
  },
  cardTextProps: {
    // v-card-text props
  },
  cardActionsProps: {
    // v-card-actions props
  },
  prependIcon: 'mdi-check-circle',
  prependIconProps: {
    // v-icon props
  },
  progressBar: boolean, // show or hide countdown progress bar
  progressBarProps: {
    // v-progress-linear props
  },
  reverseProgressBar: boolean // changes progress bar direction
  loading: boolean, // makes progressbar indeterminate
  avatar: 'https://url.to/my/image.jpg' // avatar image url,
  multipleAvatars: [
    'https://url.to/image/1.jpg',
    'https://url.to/image/2.jpg',
    'https://url.to/image/3.jpg'
    // will display first 5 images
  ],
  avatarProps: {
    // v-avatar props
  }
})

Programmatically remove toast

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

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

toast.dismiss(toastId)

You can also use the dismiss method without the id to dismiss all toasts.

// Removes all toasts

toast.dismiss()

Duration

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

<VSonner :duration="10000" />

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

// Persisent toast
toast('Event has been created', {
  duration: Number.POSITIVE_INFINITY,
})

On Close Callback

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).

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`),
})

Keyboard focus

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.

<VSonner :hotkey="['KeyC']" />

Use Underlying Vue-Sonner

vuetify-sonner, as a wrapper over the vue-sonner library, grants access to all the underlying methods and properties of vue-sonner by using the toast.toastOriginal property, e.g.

// Using Vue-Sonners Promise toast
import { toast } from 'vuetify-sonner'

const promise = () => new Promise((resolve) => setTimeout(resolve, 2000));

toast.toastOriginal
  .promise(promise, {
    loading: 'Loading...', 
    success: (data) => {
      return `${data} toast has been added`;
    },
    error: (data: any) => 'Error',
  });

See here for more on using vue-sonner

Nuxt Usage

export default defineNuxtConfig({
  build: {
    transpile: ['vue-sonner']
  }
})

<script setup lang="ts">
import { VSonner, toast } from 'vuetify-sonner'
</script>

<template>
  <VApp>
    <ClientOnly>
      <VSonner />
    </ClientOnly>
    <VBtn @click="toast('My first toast')">
      Give me a toast
    </VBtn>
  </VApp>
</template>

License

MIT