Zero-config PWA Framework-agnostic Plugin for Vite
- ๐ 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, and Svelte
- โ๏ธ Stale-while-revalidate: automatic reload when new content is available
- โจ Static assets handling: configure static assets for offline support
npm i vite-plugin-pwa -D # yarn add vite-plugin-pwa -D
๐ฉ From version
0.11.0
,workbox
has been updated to version6.2.2
(previous versions were using6.1.5
version): if you are using advanced configuration likeworkbox
orinjectManifest
options, you must review the plugin configuration, since this new version ofworkbox
has breaking changes!
Add VitePWA
plugin to vite.config.js / vite.config.ts
and configure it:
// 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 type declaration src/types.ts and the following links for more details.
MIT License ยฉ 2020-PRESENT Anthony Fu