Package Exports
- vite-plugin-pwa
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (vite-plugin-pwa) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Zero-config PWA Framework-agnostic Plugin for Vite
🚀 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, and Svelte
- ⚙️ Stale-while-revalidate: automatic reload when new content is available
- ✨ Static assets handling: configure static assets for offline support
📦 Install
npm i vite-plugin-pwa -D # yarn add vite-plugin-pwa -D
🦄 Usage
🎩 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.
👀 Full config
Check out the type declaration src/types.ts and the following links for more details.
📄 License
MIT License © 2020-PRESENT Anthony Fu