Skip to content

Deploy
- Unplugin PWA
  Release Notes
  Contributing
- Vite PWA Workbox
  Release Notes
  Contributing
- îles Module
  Github
  Documentation
- Integrations
  SvelteKit
  VitePress
  Astro
  Nuxt
  Qwik
  React Router
  TanStack
  Remix (deprecated)
API Reference

English

简体中文

Sidebar Navigation

Guide

Getting Started
Register Service Worker
Service Worker Precache
PWA Minimal Requirements
Service Worker Strategies And Behaviors
Automatic reload
Prompt for update
Advanced (buildSW)
Static assets handling
Periodic SW updates
Development
Scaffolding Your First Vite PWA Project
Service Worker without PWA capabilities
Unregister Service Worker
Testing Service Worker
Vite, Rollup, PWA and Workbox Cookbook
Change Log
FAQ

Unplugin PWA

Getting Started
Architecture Diagram
@unplugin-pwa/core
@unplugin-pwa/vite
@unplugin-pwa/webpack
@unplugin-pwa/rspack
@unplugin-pwa/inspector

Vite PWA Workbox

Getting Started
@vite-pwa/workbox-build
- generateSW
  buildSW
  injectManifest
@vite-pwa/workbox-cli
@vite-pwa/workbox-swkit
@vite-pwa/workbox-window

PWA Assets Generator

Getting Started
CLI
API
Integrations ^Experimental
Migrations

Frameworks

Getting Started
Vue
React
Svelte
SolidJS
Preact
îles
SvelteKit
VitePress
Astro
Nuxt
Qwik
Laravel
React Router
TanStack
Remix ^Deprecated

Examples

Getting Started
Vue
React
Svelte
SolidJS
Preact
îles
SvelteKit
VitePress
Astro
Nuxt
Qwik
React Router
TanStack
Remix ^Deprecated

Deploy

Getting Started
Netlify
AWS Amplify
Vercel
NGINX
Apache Http Server 2.4+

API Reference

@unplugin-pwa/core
- additional-manifest-entries
  build-pwa-asset
  config
  constants
  context
  context-types
  create-generate-register-sw-script
  create-web-manifest-html-link
  dual-sw-utilities
  generate-register-sw
  generate-web-manifest
  helpers
  html
  inject-generate-register-sw
  inject-web-manifest-html-link
  inspector-utils
  logs
  prepare-pwa-context
  prepare-sw-names
  pwa-assets
  resolve-inspector-dist
  dev/prepare-sw-names-and-glob-directory
  dev/prepare-temp-folder
  pwa-assets/build
  pwa-assets/config
  pwa-assets/dev
  pwa-assets/generator
  pwa-assets/html
  pwa-assets/manifest
  pwa-assets/options
  pwa-assets/utils
@unplugin-pwa/vite
- config
  generate-virtual-module
  helpers
  inject-manifest-hook
  legacy
  pwa-assets-resolver
  vite-context
  dev/create-hmr-script
  dev/default-service-worker-assets-normalizer
  dev/inject-hmr-script
  dev/prepare-register-sw
  dev/prepare-sw-build
  plugins/build-pwa-assets
  plugins/build-register-sw
  plugins/build-sw
  plugins/dev
  plugins/dev-middleware
  plugins/dev-pwa-assets-middleware
  plugins/devtools
  plugins/info
  plugins/inspector
  plugins/main
  plugins/pwa-assets
  plugins/virtual-modules
@vite-pwa/workbox-build
- build
  config
  build/rolldown
  build/rspack
  build/vite
  build/webpack
  utils/colors
  utils/generate-manifest-entries
  utils/resolve-sw-names
  build/rolldown/build-sw
  build/rolldown/generate-sw
  build/vite/build-sw
  build/vite/generate-sw
  build/vite/legacy-build-sw
  build/vite/legacy-generate-sw
  build/vite/legacy-types
  build/vite/plugin
@vite-pwa/workbox-cli
@vite-pwa/workbox-swkit
- background-sync
  broadcast-update
  cacheable-response
  core
  expiration
  navigation-preload
  precaching
  range-requests
  recipes
  routing
  strategies
  streams
@vite-pwa/workbox-window
- esm-sw-detector

On this page

BuildRegisterSWPlugin

Function @unplugin-pwa/vite/plugins/build-register-sw

ts

BuildRegisterSWPlugin(ctx: VitePWAPluginContext<ViteBundler, UserStrategy, T>): Plugin

Suggest changes to this page

Pager

Released under the MIT License.

Copyright © 2026-PRESENT Anthony Fu, Joaquín Sánchez