register

First added

next-pwa

Default

true

About

Whether @serwist/next should automatically register the service worker for you. If you want to register the service worker yourself, set this to false and run window.serwist.register() in componentDidMount or useEffect.

How it works

When set to true, the code injected into your app’s entrypoints runs window.serwist.register(), registering the service worker. This is rerun everytime those entrypoints are loaded.

Usage

In your next.config.js:

withSerwistInit({
  swSrc: "app/sw.ts",
  swDest: "public/sw.js",
  register: false,
});

In your app:

"use client";
import { useEffect } from "react";

export default function RegisterPWA() {
  useEffect(() => {
    if ("serviceWorker" in navigator && window.serwist !== undefined) {
      window.serwist.register();
    }
  }, []);
  return <></>;
}

Note: if you use TypeScript and follow the above template, do add @serwist/next/typings to compilerOptions.types in your tsconfig.json! This allows window.serwist to be automatically typed.