@cfware/before-install-prompt

Basic module to handle the `beforeinstallprompt` event.

Usage no npm install needed!

<script type="module">
  import cfwareBeforeInstallPrompt from 'https://cdn.skypack.dev/@cfware/before-install-prompt';
</script>

README

@cfware/before-install-prompt NPM Version

Basic module to handle the beforeinstallprompt window event.

Usage

import {promptInstallWait, promptInstallShow} from '@cfware/before-install-prompt';

function readyToShowPrompt() {
  /* This function should display a button on the page which will call
   * promptInstallShow(); when clicked.
   */
  promptInstallShow();
}

promptInstallWait(readyToShowPrompt);

promptInstallWait(callback)

Register a function to be called when promptInstallShow is able to show a prompt.

promptInstallShow()

Show the install prompt if possible. This function will silently fail if it's not possible to show the prompt.