Zero-config PWA Framework-agnostic Plugin for Vite
<img alt="NPM Downloads" src="https://img.shields.io/npm/dm/vite-plugin-pwa?color=476582&label=">
<img src="https://img.shields.io/static/v1?label=&message=docs%20%26%20guides&color=2e859c" alt="Docs & Guides">
<img src='https://cdn.jsdelivr.net/gh/antfu/static/sponsors.svg'/>
๐ Features
- ๐ 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.17, vite-plugin-pwa
requires Vite 5.
From v0.16vite-plugin-pwa
requires Node 16 or above:workbox v7
requires Node 16 or above.
From v0.13, vite-plugin-pwa
requires Vite 3.1 or above.
```bash
npm i vite-plugin-pwa -D
yarn
yarn add vite-plugin-pwa -D
pnpm
pnpm add vite-plugin-pwa -D
```
๐ฆ Usage
AddVitePWA
plugin to vite.config.js / vite.config.ts
and configure it:
```ts
// vite.config.js / vite.config.ts
import { VitePWA } from 'vite-plugin-pwa'
export default {
plugins:
VitePWA()
}
```
Read the ๐ documentation for a complete guide on how to configure and use
this plugin.
Check out the client type declarations client.d.ts for built-in frameworks support.