@mangadex-pub/vite-pwa-nuxt
v0.0.8
Published
Zero-config PWA for Nuxt 3
Downloads
3
Maintainers
Readme
🚀 Features
- 📖 Documentation & guides
- 👌 Zero-Config: sensible built-in default configs for common use cases
- 🔩 Extensible: expose the full ability to customize the behavior of the plugin
- 🦾 Type Strong: written in TypeScript
- 🔌 Offline Support: generate service worker with offline support (via Workbox)
- ⚡ Fully tree shakable: auto inject Web App Manifest
- 💬 Prompt for new content: built-in support for Vanilla JavaScript, Vue 3, React, Svelte, SolidJS and Preact
- ⚙️ Stale-while-revalidate: automatic reload when new content is available
- ✨ Static assets handling: configure static assets for offline support
- 🐞 Development Support: debug your custom service worker logic as you develop your application
📦 Install
Requires Vite 3.2.0+ and Nuxt 3.0.0+
npm i @vite-pwa/nuxt -D
# yarn
yarn add @vite-pwa/nuxt -D
# pnpm
pnpm add @vite-pwa/nuxt -D
🦄 Usage
Add @vite-pwa/nuxt
module to nuxt.config.ts
and configure it:
// nuxt.config.ts
import { defineNuxtConfig } from 'nuxt/config'
export default defineNuxtConfig({
modules: [
'@vite-pwa/nuxt'
],
pwa: {
/* PWA options */
}
})
Read the 📖 documentation for a complete guide on how to configure and use this plugin.
👀 Full config
Check out the type declaration src/types.ts and the following links for more details.
📄 License
MIT License © 2023-PRESENT Anthony Fu