Nuxt 2 is reaching End-of-Life on June 30th, 2024.

vite-pwa-nuxt
vite-pwa-nuxt

Zero-config PWA Plugin for Nuxt

@vite-pwa/nuxt - Zero-config PWA for Nuxt 3
Zero-config PWA Plugin for Nuxt 3

NPM version NPM Downloads Docs & Guides
GitHub stars


๐Ÿš€ 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, Nuxt 3 and 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+.

npx nuxi@latest module add @vite-pwa/nuxt

๐Ÿฆ„ 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 server
  • nr dev:preview:generate: Nuxt generate command + start server
ExampleSourcePlayground
Auto Update PWAGitHub Open in StackBlitz

๐Ÿ‘€ Full config

Check out the type declaration src/types.ts and the following links for more details.

๐Ÿ“„ License

MIT License ยฉ 2023-PRESENT Anthony Fu