Skip to content
vite-pwaPublic

Latest commit

ย 

History

107 Commits

Folders and files

Repository files navigation

@vite-pwa/astro - Zero-config PWA for Astro

Zero-config PWA for Astro

NPM version NPM Downloads Docs & Guides
GitHub stars


Anthony Fu SVG sponsors image

๐Ÿš€ 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: 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/core and @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

๐Ÿ“ฆ Install

From v2.0.0, @vite-pwa/astro requires Astro 5 or above.

From v0.2.0, @vite-pwa/astro requires 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 -D

๐Ÿฆ„ Usage

Add @vite-pwa/astro integration to astro.config.mjs and configure it.

โš ๏ธ Breaking Change: Starting from v2, the integration is powered by @unplugin-pwa/vite and now uses a named export (AstroPWAIntegration) instead of a default export.

v2.x

// astro.config.mjs
import { AstroPWAIntegration } from '@vite-pwa/astro'
import { defineConfig } from 'astro/config'

// https://astro.build/config
export default defineConfig({
  integrations: [AstroPWAIntegration()]
})

Read the ๐Ÿ“– v2.x documentation for a complete guide on how to configure and use this integration.

v1.x (Legacy)

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 ๐Ÿ“– v1.x documentation for a complete guide on how to configure and use this integration.

โšก๏ธ Examples

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 Open in StackBlitz
Prompt for Update PWA GitHub Open in StackBlitz

๐Ÿ‘€ Full config

Check out the following links for more details:

๐Ÿ“„ License

MIT License ยฉ 2022-PRESENT Anthony Fu

Releases

Sponsor this project

Used by

Contributors

Languages