Zero-config PWA Framework-agnostic Plugin for Vite
## ๐ 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), and [Nuxt 3](https://github.com/nuxt/nuxt)
- ๐ฅ **PWA Assets Generator**: generate all the PWA assets from a single command and a single source image
## ๐ฆ Install
> From v0.17, `vite-plugin-pwa` requires **Vite 5**.
> From v0.16 `vite-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
Add `VitePWA` 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](https://vite-pwa-org.netlify.app/guide/) for a complete guide on how to configure and use
this plugin.
Check out the client type declarations [client.d.ts](./client.d.ts) for built-in frameworks support.
## ๐ 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 © 2020-PRESENT [Anthony Fu](https://github.com/antfu)