Home

Awesome

<p align='center'> <img src='https://raw.githubusercontent.com/vite-pwa/nuxt/main/hero.png' alt="@vite-pwa/nuxt - Zero-config PWA for Nuxt 3"><br> Zero-config PWA Plugin for Nuxt 3 </p> <p align='center'> <a href='https://www.npmjs.com/package/@vite-pwa/nuxt' target="__blank"> <img src='https://img.shields.io/npm/v/@vite-pwa/nuxt?color=33A6B8&label=' alt="NPM version"> </a> <a href="https://www.npmjs.com/package/@vite-pwa/nuxt" target="__blank"> <img alt="NPM Downloads" src="https://img.shields.io/npm/dm/@vite-pwa/nuxt?color=476582&label="> </a> <a href="https://vite-pwa-org.netlify.app/frameworks/nuxt" target="__blank"> <img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20guides&color=2e859c" alt="Docs & Guides"> </a> <br> <a href="https://github.com/vite-pwa/nuxt" target="__blank"> <img alt="GitHub stars" src="https://img.shields.io/github/stars/vite-pwa/nuxt?style=social"> </a> </p> <br> <p align="center"> <a href="https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg"> <img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/> </a> </p>

๐Ÿš€ Features

๐Ÿ“ฆ 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:

<table> <thead> <tr> <th>Example</th> <th>Source</th> <th>Playground</th> </tr> </thead> <tbody> <tr> <td><code>Auto Update PWA</code></td> <td><a href="https://github.com/vite-pwa/nuxt/tree/main/playground">GitHub</a></td> <td> <a href="https://stackblitz.com/fork/github/vite-pwa/nuxt" target="_blank" rel="noopener noreferrer"> <img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open in StackBlitz" width="162" height="32"> </a> </td> </tr> </tbody> </table>

๐Ÿ‘€ Full config

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

๐Ÿ“„ License

MIT License ยฉ 2023-PRESENT Anthony Fu