- 📖 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: client virtual modules are strictly optimized for Dead Code Elimination.
- 📄 Web Manifest: auto-inject Web App Manifest and PWA assets seamlessly.
- 💬 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
- 🔍 Inspector: visually inspect your resolved configuration, web manifest and service worker during development, via middleware or DevFrame
- 🧩 Modular: use the ready-to-use plugins or compose your own integration from the building blocks in
@unplugin-pwa/coreand@unplugin-pwa/vite - 📦 Universal Bundlers: native integration with Vite, Rolldown, Webpack (WIP), Rspack (WIP), and Rsbuild (WIP).
- 🛠️ Meta-Frameworks: seamless integration with îles, SvelteKit, VitePress, Astro, Nuxt 3/4/5, React Router, TanStack and Next (WIP).
- 💥 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
From v2.0.0,
@vite-pwa/astrorequires Astro 5 or above.
From v0.2.0,
@vite-pwa/astrorequires Vite 5 and Astro 4.0.0 or above.
Using any version older than v0.2.0 requires Vite 3.1.0+.
npm i @vite-pwa/astro -D
# yarn
yarn add @vite-pwa/astro -D
# pnpm
pnpm add @vite-pwa/astro -DAdd @vite-pwa/astro integration to astro.config.mjs and configure it.
⚠️ Breaking Change: Starting from v2, the integration is powered by@unplugin-pwa/viteand now uses a named export (AstroPWAIntegration) instead of a default export.
// astro.config.mjs
import { AstroPWAIntegration } from '@vite-pwa/astro'
import { defineConfig } from 'astro/config'
// https://astro.build/config
export default defineConfig({
integrations: [AstroPWAIntegration()]
})If you are still using the 1.x version, it used a default export:
// astro.config.mjs
import AstroPWAIntegration from '@vite-pwa/astro'
import { defineConfig } from 'astro/config'
// [https://astro.build/config](https://astro.build/config)
export default defineConfig({
integrations: [AstroPWAIntegration()]
})Read the 📖 documentation for a complete guide on how to configure and use this plugin.
You need to stop the dev server once started and then run npm run build && npm run preview to see the PWA in action.
| Example | Source | Playground |
|---|---|---|
Auto Update PWA |
GitHub |
|
Prompt for Update PWA |
GitHub |
|
Check out the following links for more details:
MIT License © 2022-PRESENT Anthony Fu