@vite-pwa/react-router
v0.0.1
Published
Zero-config PWA for React Router
Readme
🚀 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/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
📦 Install
npm i @vite-pwa/react-router -D
# yarn
yarn add @vite-pwa/react-router -D
# pnpm
pnpm add @vite-pwa/react-router -D🦄 Usage
You need to provide your React Router plugin to the ReactRouterPWAPlugin:
// vite.config.ts
import { defineConfig } from 'vite'
import { ReactRouterPWAPlugin } from '@vite-pwa/react-router'
const reactRouterPlugin = reactRouter()
export default defineConfig({
plugins: [
reactRouterPlugin,
ReactRouterPWAPlugin(
reactRouterPlugin,
{
/* PWA options */
}
)
]
})then, add the ReactRouterPWAPreset to your React Router configuration:
// react-router.config.ts
import type { Config } from '@react-router/dev/config'
import { ReactRouterPWAPreset } from '@vite-pwa/react-router/preset'
export default {
// Config options...
// Server-side render by default, to enable SPA mode set this to `false`
presets: [ReactRouterPWAPreset()]
} satisfies ConfigRead 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 © 2026-PRESENT Anthony Fu
