JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 36106
  • Score
    100M100P100Q164294F
  • License Unlicense

PWA install dialog provide more convenience user experience and fix lack of native dialogs in some browsers.

Package Exports

  • @khmyznikov/pwa-install

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@khmyznikov/pwa-install) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Published on NPM

<pwa-install>

Installation dialog for Progressive web component. Provides more convenience user experience and fix lack of native dialogs in some browsers. 13.5kB brotli compressed bundle.

iOS iOS install iOS gallery
IMG_0345-min IMG_1541-min IMG_0346-min
Android Android gallery Dark theme
Screenshot_20210619-152257-min Screenshot_20210619-152248-min Screenshot_20210619-151933-min
Chrome Chrome gallery
Screenshot 2021-06-19 153758-min Screenshot 2021-06-19 153810-min

Install

npm i @khmyznikov/pwa-install

Alternatively, you can use unpkg.

Import

import '../node_modules/@khmyznikov/pwa-install/dist/bundle.js';

Use

<pwa-install></pwa-install>

Demo

Supported params

<pwa-install
  manual-apple="true"
  manual-chrome="true"
  disable-chrome="true"

  manifest-url="/manifest.json"
  name="PWA"
  description="Progressive web application"
  icon="/icon.png">
</pwa-install>

Make a good manifest file and don't use name/descr/icon params

Supported events

  • pwa-install-success-event
  • pwa-install-fail-event
  • pwa-install-available-event
  • pwa-user-choice-result-event
<script type="text/javascript">
  var pwaInstall = document.getElementsByTagName('pwa-install')[0];

  pwaInstall.addEventListener('pwa-install-success-event', (event) => {console.log(event.detail.message)});
</script>

Supported properties (readonly)

  • userChoiceResult: string;
  • isDialogHidden: boolean
  • isInstallAvailable: boolean
  • isAppleMobilePlatform: boolean
  • isUnderStandaloneMode: boolean
  • isRelatedAppsInstalled: boolean
<script type="text/javascript">
  var pwaInstall = document.getElementsByTagName('pwa-install')[0];

  console.log(pwaInstall.isUnderStandaloneMode);
</script>

Supported methods

  • install
  • hideDialog
  • showDialog
  • getInstalledRelatedApps: async
<script type="text/javascript">
  var pwaInstall = document.getElementsByTagName('pwa-install')[0];

  pwaInstall.install();
</script>

ROADMAP

  • more params/methods/events
  • translation
  • style customization