Modules
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
- ๐ ๏ธ Versatile: integration with meta frameworks: รฎles, SvelteKit, VitePress, Astro, and Nuxt 3
- ๐ฅ PWA Assets Generator: generate all the PWA assets from a single command and a single source image
๐ฆ Install
From v0.4.0,
@vite-pwa/nuxt
requires Vite 5 and Nuxt 3.9.0+.
For older versions,
@vite-pwa/nuxt
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.
โก๏ธ Examples
You need to stop the dev server once started and then to see the PWA in action run:
nr dev:preview:build
: Nuxt build command + start servernr dev:preview:generate
: Nuxt generate command + start server
Example | Source | Playground |
---|---|---|
Auto Update PWA | GitHub |
๐ Full config
Check out the type declaration src/types.ts and the following links for more details.
๐ License
MIT License ยฉ 2023-PRESENT Anthony Fu