Zero-config PWA Plugin for Nuxt 3

🚀 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+

1npm i @vite-pwa/nuxt -D 
2
3# yarn 
4yarn add @vite-pwa/nuxt -D
5
6# pnpm 
7pnpm add @vite-pwa/nuxt -D

🦄 Usage

Add @vite-pwa/nuxt module to nuxt.config.ts and configure it:

1// nuxt.config.ts
2import { defineNuxtConfig } from 'nuxt/config'
3
4export default defineNuxtConfig({
5  modules: [
6    '@vite-pwa/nuxt'
7  ],
8  pwa: {
9    /* PWA options */
10  }
11})

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.

• Web app manifests
• Workbox

📄 License

MIT License © 2023-PRESENT Anthony Fu