Skip to content

adrianjanocko/toastflow

Repository files navigation

Toastflow

🔔 Toastflow

Framework-agnostic toast engine with Vue 3 renderer and Nuxt module support.
Typed core · smooth stack animations · CSS-first theming · full layout control.

vue-toastflow nuxt-toastflow toastflow-core License

📖 Docs · 🎮 Playground · ⚔️ Comparisons


📦 Packages

Package Version Description
🟢 vue-toastflow npm Vue 3 plugin — components, programmatic API, styles
💚 nuxt-toastflow npm Nuxt module — auto-imports, SSR, zero config
⚙️ toastflow-core npm Framework-agnostic core — store, timers, queue, events

🚀 Quick Start

Vue 3

pnpm add vue-toastflow
import { createToastflow } from "vue-toastflow";

createApp(App).use(createToastflow()).mount("#app");

Nuxt

pnpm add nuxt-toastflow
export default defineNuxtConfig({
  modules: ["nuxt-toastflow"],
});

💡 Check the Getting Started guide for full setup with examples.

✨ Highlights

  • 🎯 Typed from core to UI — full TypeScript, no any
  • 🎨 CSS-first theming — override CSS variables, no JS config needed
  • 📚 Queue & stack managementmaxVisible, auto-queue, smooth animations
  • ⏱️ Timer controls — pause on hover, progress bars, loading toasts
  • 🧩 Composable architecture — slots, events, headless mode
  • 🔌 Framework-agnostic core — bring your own renderer

🏗️ Development

pnpm install        # 📥 install all dependencies
pnpm build          # 🔨 build all packages
pnpm test           # 🧪 run all tests
pnpm lint           # 🔍 lint
pnpm format         # 💅 format with Prettier

🗂️ Monorepo Structure

toastflow/
├── 📦 packages/
│   ├── 🟢 vue/           → vue-toastflow
│   ├── 💚 nuxt/          → nuxt-toastflow
│   ├── ⚙️ core/          → toastflow-core
│   ├── 📖 docs/vue/      → VitePress docs
│   ├── 🎮 playground/vue → local playground app
│   └── 🧪 test/nuxt/     → Nuxt smoke test
└── 🖼️ assets/            → shared assets

📄 License

MIT — made with ❤️ by @adrianjanocko

About

Framework-agnostic toast engine with Vue 3 renderer and Nuxt module support. Typed core, smooth stack animations, CSS-first theming, and full control over layout and behavior.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages