vcf-pwa-install-dialog | Vaadin

Vaadin Component Factory PWA Install Dialog




Install vcf-pwa-install-dialog:

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


Once installed, import it in your application:

import '@vaadin-component-factory/vcf-pwa-install-dialog/vcf-pwa-install-dialog.js';

And use it:

  <div dialog-content>
    Dialog content

Wrap the content of dialog in an element with dialog-content attribute.


The following selectors are available for styling:

  • [part='wrapper']: The element that wraps all the elements inside the dialog.
  • [part='content']: The element that wraps the contents of dialog.

How to provide styles of the content:

Create a dom-module element like the following example and add your styles:

<dom-module id="my-pwa-styles" theme-for="vcf-pwa-install-dialog">
      [part='wrapper'] {
        padding: 1em;
      [part='content'] {
        max-width: 25em;

Refer to demos for real-world examples.


  • close-text: The text for "Close" button.
  • button-text: The text for "Install" button.
  • stop-showing-text: The text for "Stop Showing" checkbox.
  • opened: Use it to toggle the dialog.


The component fires 5 custom events:

  • vcf-pwa-prompt-shown: when the dialog opens.
  • vcf-pwa-prompt-dismissed: when the dialog is closed.
  • vcf-pwa-install-triggered: when the user clicks the "install app" button.
  • vcf-pwa-install-successful: when the user installs the app.
  • vcf-pwa-install-cancelled: when the user cancels the installation of the app.

When the user checks the "Stop Showing" checkbox, a variable called vcf-pwa-stop-showing is saved on localStorage. You can use this variable to avoid showing the dialog in future visits.

Refer to demos for an example.

Running demo

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

  2. Make sure you have npm installed.

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

  4. Run npm start to open the demo.


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


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


Link to this version
ImportedReleased 03 September 2019Other
Framework Support
Polymer 3.0+
Browser Independent
Install with
npm install @vaadin-component-factory/vcf-pwa-install-dialog"@1.0.0"
Run the above npm command in your project folder. If you have any issues installing, please contact the author.
Release notes - Version 1.0.0


  • @polymer/polymer#^3.0.0
  • @vaadin-component-factory/vcf-pwa-install-helpers#^0.1.0
  • @vaadin/vaadin-button#2.2.0
  • @vaadin/vaadin-checkbox#^2.2.10
  • @vaadin/vaadin-dialog#^2.2.1
  • @vaadin/vaadin-element-mixin#^2.1.3
  • @vaadin/vaadin-lumo-styles#^1.5.0
  • @vaadin/vaadin-themable-mixin#^1.4.4