@vaadin-component-factory/vcf-pwa-install-button

Vaadin Component Factory pwa-install-button

Usage no npm install needed!

<script type="module">
  import vaadinComponentFactoryVcfPwaInstallButton from 'https://cdn.skypack.dev/@vaadin-component-factory/vcf-pwa-install-button';
</script>

README

<vcf-pwa-install-button>

Demo

https://vcf-pwa-install-button.netlify.com/

Installation

Install vcf-pwa-install-button:

npm i @vaadin-component-factory/vcf-pwa-install-button --save

Usage

Once installed, import it in your application:

import '@vaadin-component-factory/vcf-pwa-install-button';

And use it:

<vcf-pwa-install-button>Button caption</vcf-pwa-install-button>

Events

The component fires 3 custom events:

  • vcf-pwa-install-triggered: when the user click the button.
  • vcf-pwa-install-successful: when the user installs the app.
  • vcf-pwa-install-cancelled: when the user cancels the installation of the app.

Running demo

  1. Fork the vcf-pwa-install-button repository and clone it locally.

  2. Make sure you have npm installed.

  3. When in the vcf-pwa-install-button directory, run npm install to install dependencies.

  4. Run npm start to open the demo.

Contributing

To contribute to the component, please read the guideline first.

License

Apache License 2.0