BeforeInstallPrompt

The BeforeInstallPromptEvent is passed into the onbeforeinstallprompt handler and displatched when a web manifest exists, but before a user is prompted to save a web site to a home screen on mobile.

This interface inherits from the Event interface.

 
  <div id="interfaceDiagram" style="display: inline-block; position: relative; width: 100%; padding-bottom: 8.571428571428571%; vertical-align: middle; overflow: hidden;"><svg style="display: inline-block; position: absolute; top: 0; left: 0;" viewbox="-20 0 700 60" preserveAspectRatio="xMinYMin meet"><a xlink:href="https://developer.mozilla.org/en-US/docs/Web/API/BeforeInstallPromptEvent" target="_top"><rect x="1" y="1" width="240" height="50" fill="#F4F7F8" stroke="#D4DDE4" stroke-width="2px" /><text  x="121" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">BeforeInstallPromptEvent</text></a></svg></div> 

 
  a:hover text { fill: #0095DD; pointer-events: all;} 

Constructor

BeforeInstallPromptEvent.BeforeInstallPromptEvent()

Creates a new BeforeInstallPromptEvent.

Properties

Inherits properties from its parent, Event.

BeforeInstallPromptEvent.platform Read only

Returns a DOMString containing the platform on which the event was dispatched.

BeforeInstallPromptEvent.userChoice Read only

Returns a Promise that resolves to a DOMString containing either 'installed' or 'dismissed'.

Example

window.addEventListener("beforeinstallprompt", function(e) { 
  // log the platforms provided as options in an install prompt 
  console.log(e.platforms); // e.g., ["web", "android", "windows"] 
  e.userChoice.then(function(platform, outcome) { 
    console.log(platform); // the platform of the app the user took an action on 
    console.log(outcome); // either "installed", "dismissed", etc. 
  }, handleError); 
});

Browser compatibility

[1] beforeinstallprompt event is supported in Chrome 44, but it is behind the flagchrome://flags/#bypass-app-banner-engagement-checks