npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@pigs/plugin-pwa

v12.0.3

Published

Build a progressive web app with Pigs and [Workbox](https://developers.google.com/web/tools/workbox/).

Downloads

3

Readme

@pigs/plugin-pwa

Build a progressive web app with Pigs and Workbox.

Install

yarn add @pigs/plugin-pwa --dev

How to use

In your pigs.config.js:

module.exports = {
  plugins: [
    {
      resolve: '@pigs/plugin-pwa',
      options: {}
    }
  ]
}

Then run Pigs in production mode will generate a /service-worker.js file, you can register it in your app to make your website offline-ready.

You can manually register the service worker following the official guide, but there's also a module on npm which can be used to simplify the process:

yarn add register-service-worker
import { register } from 'register-service-worker'

register(process.env.PUBLIC_URL + 'service-worker.js', {
  ready(registration) {
    console.log('Service worker is active.')
  },
  registered(registration) {
    console.log('Service worker has been registered.')
  },
  cached(registration) {
    console.log('Content has been cached for offline use.')
  },
  updatefound(registration) {
    console.log('New content is downloading.')
  },
  updated(registration) {
    console.log('New content is available; please refresh.')
  },
  offline() {
    console.log('No internet connection found. App is running in offline mode.')
  },
  error(error) {
    console.error('Error during service worker registration:', error)
  }
})

Options

Default value:

{
  name: 'PWA app',
  themeColor: '#74d7fd', // The Pigs color
  msTileColor: '#000000',
  appleMobileWebAppCapable: 'no',
  appleMobileWebAppStatusBarStyle: 'default',
  assetsVersion: '',
  iconPaths: {
    favicon16: 'img/icons/favicon-16x16.png',
    favicon32: 'img/icons/favicon-32x32.png',
    appleTouchIcon: 'img/icons/apple-touch-icon-152x152.png',
    safariMaskIcon: 'img/icons/safari-mask-icon.svg',
    msTileImage: 'img/icons/msapplication-icon-144x144.png'
  }
}

We use these options to generate manifest.json and update PWA-related tags in generated index.html file.

If you don't want to support some platform icons, simply pass false as the icon path, for example:

{
  iconPaths: {
    msTileImage: false
  }
}

Then we won't add HTML tag for this icon in index.html.

To customize the manifest.json, you can simply populate a public/manifest.json and we will merge it with our default one.