vcf-pwa-install-button - Vaadin Add-on Directory
Vaadin Component Factory PWA Install Button# <vcf-pwa-install-button>
## Demo
https://vcf-pwa-install-button.netlify.com/
## Installation
Install `vcf-pwa-install-button`:
```sh
npm i @vaadin-component-factory/vcf-pwa-install-button --save
```
## Usage
Once installed, import it in your application:
```js
import '@vaadin-component-factory/vcf-pwa-install-button/vcf-pwa-install-button.js';
```
And use it:
```html
Button caption
```
### 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.
1. Make sure you have [npm](https://www.npmjs.com/) installed.
1. When in the `vcf-pwa-install-button` directory, run `npm install` to install dependencies.
1. Run `npm start` to open the demo.
## Contributing
To contribute to the component, please read [the guideline](https://github.com/vaadin/vaadin-core/blob/master/CONTRIBUTING.md) first.
## License
Commercial Vaadin Add-on License version 3 (CVALv3). For license terms, see LICENSE.
Vaadin collects development time usage statistics to improve this product. For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.