Window.onbeforeinstallprompt

 

Non-standard
This feature is non-standard and is not on a standards track. Do not use it on production sites facing the Web: it will not work for every user. There may also be large incompatibilities between implementations and the behavior may change in the future.

The Window.onbeforeinstallprompt property is an event handler for processing a beforeinstallprompt, which is dispatched on mobile when a web manifest exists, but before a user is prompted to save a web site to a home screen.

Syntax

window.addEventListener("beforeinstallprompt", function(event) { ... });
window.onbeforeinstallprompt = function(event) { ...};

Example

The following example uses the beforeinstallprompt function to verify that it is an appropriate time to display an installation prompt to the user. If it is not, the event is redispatched.

var isTooSoon = true;
window.addEventListener("beforeinstallprompt", function(e) { 
  if (isTooSoon) {
    e.preventDefault(); // Prevents prompt display 
    // Prompt later instead: 
    setTimeout(function() { 
      isTooSoon = false; 
      window.dispatchEvent(e); // Shows prompt 
    }, 10000); 
  } 

  // The event was re-dispatched in response to our request 
  // ... 
});

Browser compatibility

Feature Chrome Firefox (Gecko) Internet Explorer Opera Safari
Basic support 45.0 Not supported Not supported Not supported Not supported
Feature Android Android Webview Firefox Mobile (Gecko) IE Mobile Opera Mobile Safari Mobile Chrome for Android
Basic support Not supported 45.0 Not supported Not supported Not supported Not supported 45.0

Specification

This event is not part of a specification.

Document Tags and Contributors

 Contributors to this page: teoli, jpmedley
 Last updated by: teoli,