.An opinionated toast element for Vue. It is actually a Vue slot of Sonner.Preview.https://user-images.githubusercontent.com/6118824/228208185-be5aefd4-7fa8-4f95-a41c-88a60c0e2800.mp4.Introduction.Vue Sonner is an opinionated tribute element for Vue. It is actually personalized, however designated through nonpayment. Comes with a swipe to reject computer animation.Installation.To begin using the public library, mount it in your job:.pnpm put in vue-sonner.or.yarn add vue-sonner.Usage.For Vue 3.
Render a tribute.
For Nuxt 3.Define a nuxt plugin.// plugins/sonner. client.ts.bring in Toaster oven, salute from 'vue-sonner'.export default defineNuxtPlugin(( nuxtApp) => nuxtApp.vueApp.component(' Toaster oven', Toaster).profits offer: salute. ).Make use of Toaster element and also $tribute function throughout the Vue SFC.
Leave a salute.
Include the construct transpile for vue-sonner.// nuxt.config.ts.bring in defineNuxtConfig coming from 'nuxt/config'.export nonpayment defineNuxtConfig( ...create: transpile: [' vue-sonner'] ).CDN Hyperlink.Ambulance variation.https://cdn.jsdelivr.net/npm/vue-sonner/+esm.UMD model.https://www.unpkg.com/vue-sonner@0.3.1/lib/vue-sonner.umd.cjs.Types.Default.The majority of essential tribute. You can tailor it (as well as every other type) by passing a choices item as the 2nd argument.salute(' Activity has been created').With custom-made description:.toast(' Activity has actually been produced', description: 'Monday, January 3rd at 6:00 pm'. ).Excellence.Leaves a checkmark symbol in front of the notification.toast.success(' Event has been developed').Inaccuracy.Leaves an inaccuracy symbol facing the message.toast.error(' Event has actually certainly not been created').Action.Provides a button.toast(' Activity has been actually developed', activity: label: 'Undo',.onClick: () => console.log(' Undo'). ).Promise.Starts in a filling condition and is going to update instantly after the commitment addresses or stops working.You may pass a function to the success/error information to include the result/error of the commitment.toast.promise(() => brand new Guarantee(( willpower) => setTimeout( willpower, 2000)), filling: 'Filling',.results: (records: any type of) => 'Results',.mistake: (records: any) => 'Inaccuracy'. ).Custom Component.You can pass a Vue Element as the initial disagreement instead of a cord to render custom-made Element while maintaining nonpayment designing. You may use the brainless variation listed below for a customized, unstyled salute.Modification.Headless.You can easily use toast.custom to render an unstyled salute along with custom-made jsx while keeping the performance.Concept.You can easily modify the concept making use of the motif prop. Default motif is actually lightweight.Posture.You may transform the setting via the position uphold on the part. Nonpayment is actually top-right.
Extended.Toasts can additionally be actually broadened by default via the expand prop. You can additionally alter the quantity of obvious salutes which is actually 3 by default.Styling for all salutes.You can easily design your tributes globally along with the toastOptions set in the Toaster component.Designing for private tribute.toast(' Activity has actually been actually made', type: history: 'reddish'.,.className: 'my-toast',.descriptionClassName: 'my-toast-description'. ).Close switch.Add a close switch to all salutes that presents on hover through including the closeButton prop.Rich colours.You can easily make mistake and effectiveness state even more vibrant by adding the richColors uphold.Custom balanced out.Balanced out coming from the edges of the monitor.Programmatically eliminate tribute.To take out a salute programmatically make use of toast.dismiss( id).const toastId = toast(' Activity has actually been actually made').toast.dismiss( toastId).You can likewise make use of the put away procedure without the id to put away all salutes.toast.dismiss().Programmatically get rid of toast.You can modify the period of each toast by using the period attribute, or transform the timeframe of all salutes enjoy this:.toast(' Event has been created', duration: 10000. ).// Persisent salute.tribute(' Occasion has been generated', length: Immensity. ).On Close Callback.You may pass onDismiss and onAutoClose callbacks. onDismiss acquires discharged when either the close switch gets hit or even the tribute is swiped. onAutoClose fires when the salute goes away instantly after it's timeout (length prop).tribute(' Occasion has been actually created', onDismiss: (t) => console.log( 'Toast with i.d. $ t.id has actually been rejected '),.onAutoClose: (t) =>console.log( 'Toast along with i.d. $ t.id has been actually finalized instantly '). ).Computer keyboard focus.You can easily pay attention to the salute area through pushing u2325/ alt + T. You can easily override it by delivering a range of event.code worths for each and every trick.Ideas.sonner - An opinionated tribute part for React.