npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

surge-toast

v0.1.0

Published

A Vue 3 + Inertia plugin to render headless toast components.

Downloads

4

Readme

Surge Toast

A headless toast package for use in Vue-Inertia-Laravel projects. For seamless integration, use the Surge Toast composer package in Laravel.

Installation

npm install surge-toast

If you want to use the Laravel flash message integration, you can install the Laravel package as well. For documentation, see the package here.

composer require surge/toast

And then in the app.js or app.ts file of your project, use the plugin:

import { toast } from "surge-toast"

//...

app.use(toast)

Within a, preferably, layout file define your Toast component and access the useToast hook.

<template>
    <!-- ... -->
    <Toast v-for="toast in toasts" :key="toast.id" :toast="toast" />
</template>

<script setup>
import { Toast } from '@/Components/Toast'
import { useToast } from "surge-toast"

const { toasts } = useToast()
</script>

Usage

The package comes with a Laravel plugin that can be used to automatically render toast messages from the server on your frontend. This is handled automatically through intercepting the Inertia JS events, and sending via the event bus.

You can also call the toasts manually using the useToast hook.

Examples [Coming Soon]

The examples/ directory contains three examples for using the package.

  • A generic Tailwind toast component with Vue transitions
  • A generic Tailwind toast component with HeadlessUI control
  • shadcn-vue sonner component

You can copy these examples directly and modify as desired. If you are going to handle the logic yourself, ensure the key when performing a v-for loop is set to be toast.id or index to ensure smooth rendering in the VDom.

License

The MIT License (MIT). Please see License File for more information.