Zero-config PWA Plugin for Nuxt 3
## ๐ Features
- ๐ [**Documentation & guides**](https://vite-pwa-org.netlify.app/)
- ๐ **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](https://www.typescriptlang.org/)
- ๐ **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](https://github.com/ElMassimo/iles), [SvelteKit](https://github.com/sveltejs/kit), [VitePress](https://github.com/vuejs/vitepress), [Astro](https://github.com/withastro/astro), [Nuxt 3](https://github.com/nuxt/nuxt) and [Remix](https://github.com/remix-run/remix)
- ๐ฅ **PWA Assets Generator**: generate all the PWA assets from a single command and a single source image
- ๐ **PWA Assets Integration**: serving, generating and injecting PWA Assets on the fly in your application
## ๐ฆ 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+.
```bash
npx nuxi@latest module add @vite-pwa/nuxt
```
## ๐ฆ Usage
Add `@vite-pwa/nuxt` module to `nuxt.config.ts` and configure it:
```ts
// nuxt.config.ts
import { defineNuxtConfig } from 'nuxt/config'
export default defineNuxtConfig({
modules: [
'@vite-pwa/nuxt'
],
pwa: {
/* PWA options */
}
})
```
Read the [๐ documentation](https://vite-pwa-org.netlify.app/frameworks/nuxt) 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 server
- `nr 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](./src/types.ts) and the following links for more details.
- [Web app manifests](https://developer.mozilla.org/en-US/docs/Web/Manifest)
- [Workbox](https://developers.google.com/web/tools/workbox)
## ๐ License
[MIT](./LICENSE) License © 2023-PRESENT [Anthony Fu](https://github.com/antfu)