@vite-pwa/remix - Zero-config PWA Plugin for Remix and React Router
Zero-config PWA Plugin for Remix and React Router

NPM version NPM Downloads Docs & Guides
GitHub stars

• 📖 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, 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, Nuxt 3 and Remix
• 💥 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

@vite-pwa/remix requires Vite 5 and Remix 2.8.0 or above or React Router 7.4.0 or above.

npm i @vite-pwa/remix -D
# yarn
yarn add @vite-pwa/remix -D
# pnpm
pnpm add @vite-pwa/remix -D

Import the @vite-pwa/remix helper, create the React Router PWA Preset and the PWA Plugin and configure them in your Vite configuration file:

// vite.config.js
import { reactRouter } from '@react-router/dev/vite'
import { defineConfig } from 'vite'
import { ReactRouterVitePWAPlugin } from '@vite-pwa/remix'
const { ReactRouterVitePWAPlugin } = ReactRouterVitePWA()
export default defineConfig({
 plugins: [
 reactRouter(),
 ReactRouterVitePWAPlugin({
 // PWA options
 })
 ]
})

// react-router.config.ts
import { ReactRouterPreset } from '@vite-pwa/remix'
export default {
 ssr: process.env.SPA !== 'true',
 presets: [ReactRouterPreset],
}

// vite.config.js
import { vitePlugin as remix } from '@remix-run/dev'
import { installGlobals } from '@remix-run/node'
import { defineConfig } from 'vite'
import { RemixVitePWA } from '@vite-pwa/remix'
installGlobals()
const { RemixVitePWAPlugin, RemixPWAPreset } = RemixVitePWA()
export default defineConfig({
 plugins: [
 remix({
 presets: [RemixPWAPreset()],
 }),
 RemixVitePWAPlugin({
 // PWA options
 })
 ]
})

Read the 📖 documentation for a complete guide on how to configure and use this plugin.

Check out the following links for more details:

• Web app manifests
• Workbox

MIT License © 2024-PRESENT Anthony Fu