nuxt-toastflow
Nuxt module for Toastflow — accessible, customizable toast notifications with auto-imports, SSR support, and CSS-first theming.
2,507
207
| Install | |
|---|---|
npm install nuxt-toastflow |
|
| Latest Version: | 1.1.0 |
| Vue: | 3 |
| License: | MIT |
| Last Updated: | Aug 31, 2026 |
| Links: | GitHub · npm |
Maintainer: adrianjanocko
💚 nuxt-toastflow
Nuxt module for Toastflow — auto-imports, SSR support, and zero-config setup.
📖 Docs · 🎮 Playground · ⚔️ Comparisons
🚀 Quick Start
1. Install
pnpm add nuxt-toastflow
2. Add the module
// nuxt.config.ts
export default defineNuxtConfig({
modules: ["nuxt-toastflow"],
toastflow: {
config: {
position: "top-right",
duration: 5000,
},
},
});
3. Toast away 🎉
<!-- app.vue -->
<script setup lang="ts">
toast.success({
title: "Saved",
description: "Your changes are live.",
});
</script>
<template>
<ToastContainer />
<NuxtPage />
</template>
💡 Both
toastanduseToast()are auto-imported — no manual imports needed!
If you need the lower-level Vue runtime pieces directly, import them from nuxt-toastflow/runtime:
import {
Toast,
ToastProgress,
ToastContainer,
toast,
} from "nuxt-toastflow/runtime";
⚙️ Module Options
| Option | Type | Default | Description |
|---|---|---|---|
🛠️ config |
Partial<ToastConfig> |
{} |
Toast configuration passed to the plugin |
🎨 css |
boolean |
true |
Include default styles |
🧱 componentName |
string | false |
"ToastContainer" |
Auto-registered client-only component name |
💡 How does it work under the hood?
ToastContaineris auto-registered as a client-only componenttoastanduseToast()are auto-imported — use either onevue-toastflowis added to the transpile list so internal components resolve correctly- Styles are injected automatically unless
css: false - The module forwards
csstocreateToastflow(..., { css }), so it uses the same CSS toggle asvue-toastflow - When you disable CSS and still want the shipped stylesheet manually, import
nuxt-toastflow/styles.css
📄 License
MIT — made with ❤️ by @adrianjanocko
Related Packages
vue-toastflow
Framework-agnostic toast engine with a Vue 3 renderer. Typed core, smooth stack...
17,273
207
Version History
| Version | Released | Vue | License |
|---|---|---|---|
| 1.1.0 | ^3.0 | MIT | |
| 1.0.3 | ^3.0 | MIT | |
| 1.0.2 | ^3.0 | MIT | |
| 1.0.1 | ^3.0 | MIT | |
| 1.0.0 | ^3.0 | MIT |
Pre-releases (5)
| Version | Released | Vue | License |
|---|---|---|---|
| 1.0.2-beta.3 | ^3.0 | MIT | |
| 1.0.2-beta.2 | ^3.0 | MIT | |
| 1.0.2-beta.1 | ^3.0 | MIT | |
| 1.0.2-beta.0 | ^3.0 | MIT | |
| 1.0.1-beta.0 | ^3.0 | MIT |