# @kdupress/plugin-pwa (opens new window)

PWA plugin

# Install

yarn add -D @kdupress/plugin-pwa
# OR npm install -D @kdupress/plugin-pwa

# Usage

module.exports = {
  plugins: ['@kdupress/pwa']
}

Here is an example of a fully PWA-compliant configuration with KduPress:

module.exports = {
  head: [
    ['link', { rel: 'icon', href: '/logo.png' }],
    ['link', { rel: 'manifest', href: '/manifest.json' }],
    ['meta', { name: 'theme-color', content: '#3eaf7c' }],
    ['meta', { name: 'apple-mobile-web-app-capable', content: 'yes' }],
    ['meta', { name: 'apple-mobile-web-app-status-bar-style', content: 'black' }],
    ['link', { rel: 'apple-touch-icon', href: '/icons/apple-touch-icon-152x152.png' }],
    ['link', { rel: 'mask-icon', href: '/icons/safari-pinned-tab.svg', color: '#3eaf7c' }],
    ['meta', { name: 'msapplication-TileImage', content: '/icons/msapplication-icon-144x144.png' }],
    ['meta', { name: 'msapplication-TileColor', content: '#000000' }]
  ],
  plugins: [
    [
      '@kdupress/pwa',
      {
        serviceWorker: true,
        updatePopup: true
      }
    ]
  ],
}

# Options

# serviceWorker

• Type: boolean
• Default: true

If set to true, KduPress will automatically generate and register a service worker (opens new window) that caches the content for offline use (only enabled in production).

There is a aliased module @sw-event module that will also be emitting the following events:

• sw-ready
• sw-cached
• sw-updated
• sw-offline
• sw-error

# generateSWConfig

• Type: object
• Default: {}

generateSW config (opens new window) of workbox-build.

# updatePopup

• Type: boolean|object
• Default: undefined

The definition of type popupConfig is as follows:

interface normalPopupConfig {
  message: string; // defaults to 'New content is available.'
  buttonText: string; // defaults to 'Refresh'
}

interface localedPopupConfig {
  [localePath: string]: normalPopupConfig
}

type popupConfig = normalPopupConfig | localedPopupConfig

This option enables the popup to refresh contents. The popup will be shown when the site is updated (i.e. service worker is updated). It provides refresh button to allow users to refresh contents immediately.

If without the refresh button, the new service worker will be active after all clients (opens new window) are closed. This means that visitors cannot see new contents until they close all tabs of your site. But the refresh button activates the new service worker immediately.

# popupComponent

• Type: string
• Default: undefined

A custom component to replace the default popup component.

Also see:

• Customize the SW-Update Popup UI

# Customize the UI of SW-Update Popup

The default sw-update popup component provides a default slot which gives you the ability to fully control the appearance of the popup.

First, you need to create a global component (e.g. MySWUpdatePopup) at .kdupress/components. A simple component created based on the default component is as follows:

<template>
  <SWUpdatePopup k-slot="{ enabled, reload, message, buttonText }">
    <div
      k-if="enabled"
      class="my-sw-update-popup">
      {{ message }}<br>
      <button @click="reload">{{ buttonText }}</button>
    </div>
  </SWUpdatePopup>
</template>

<script>
import SWUpdatePopup from '@kdupress/plugin-pwa/lib/SWUpdatePopup.kdu'

export default {
  components: { SWUpdatePopup }
}
</script>

<style>
.my-sw-update-popup {
  text-align: right;
  position: fixed;
  bottom: 20px;
  right: 20px;
  background-color: #fff;
  font-size: 20px;
  padding: 10px;
  border: 5px solid #3eaf7c;
}

.my-sw-update-popup button {
  border: 1px solid #fefefe;
}
</style>

Then, update your plugin config:

module.exports = {
   plugins: {
    '@kdupress/pwa': {
       serviceWorker: true,
+      popupComponent: 'MySWUpdatePopup',
       updatePopup: true
     }
  }
}

Also see:

• KduPress > Using Components
• Kdu > Scoped Slots (opens new window)