vite-plugin-pwa

Zero-config PWA for Vite

VitePWA
vite-pwa/vite-plugin-pwavite-pwa-org.netlify.app/vite-plugin-pwa

README

vite-plugin-pwa


🚀 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
- 🔌 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, and Nuxt 3

📦 Install


From v0.13, vite-plugin-pwa requires Vite 3.1 or above.


  1. ```bash
  2. npm i vite-plugin-pwa -D

  4. # yarn
  5. yarn add vite-plugin-pwa -D

  7. # pnpm
  8. pnpm add vite-plugin-pwa -D
  9. ```

🦄 Usage


Add VitePWA plugin to vite.config.js / vite.config.ts and configure it:

  1. ```ts
  2. // vite.config.js / vite.config.ts
  3. import { VitePWA } from 'vite-plugin-pwa'

  5. export default {
  6.   plugins: [
  7.     VitePWA()
  8.   ]
  9. }
  10. ```

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.

👀 Full config


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

- Web app manifests
- Workbox


📄 License


MIT License © 2020-PRESENT Anthony Fu