0.0.4 • Published 5 years ago

pwa-install v0.0.4

Weekly downloads
33
License
MIT
Repository
-
Last release
5 years ago

Built With Stencil

pwa-install

pwa-install is a web component built with Stencil that brings an awesome "install" experience to your Progressive Web App! It is still early for this component, but expect lots of improvements soon!

What does it look like?

An image of what the component looks like

Using this component

Things to know:

  • pwa-install uses the beforeinstallprompt event described in these docs to know when the browser has said your PWA is installable. It will not show the install button until this event has fired. This can be worked around by using the forceshow prop described below.
  • pwa-install currently takes advantage of these parts of the w3c manifest spec: name, categories, description, screenshots

Install

Script tag

  • Put these two script tags in the head of your index.html:
  <script type="module" src="https://unpkg.com/pwa-install/dist/pwa-install/pwa-install.esm.js"></script>
  <script nomodule="" src="https://unpkg.com/pwa-install/dist/pwa-install/pwa-install.js"></script>

API

Properties

PropertyAttributeDescriptionTypeDefault
forceshowforceshowWill always show install buttonbooleanundefined
iconpathiconpathpath to app iconstringundefined
manifestpathmanifestpathpath to your web manifeststringundefined
0.0.4

5 years ago

0.0.3

5 years ago

0.0.2

5 years ago

0.0.1

5 years ago