The BeforeInstallPromptEvent is the interface of the beforeinstallprompt event fired at the Window object before a user is prompted to "install" a website to a home screen on mobile.
This interface inherits from the Event interface.
BeforeInstallPromptEvent
Constructor
-
BeforeInstallPromptEvent() -
Creates a new
BeforeInstallPromptEvent.
Properties
Inherits properties from its parent, Event.
-
BeforeInstallPromptEvent.platformsRead only -
Returns an array of
DOMStringitems containing the platforms on which the event was dispatched. This is provided for user agents that want to present a choice of versions to the user such as, for example, "web" or "play" which would allow the user to choose between a web version or an Android version. -
BeforeInstallPromptEvent.userChoiceRead only -
Returns a
Promisethat resolves to aDOMStringcontaining either "accepted" or "dismissed".
Methods
-
BeforeInstallPromptEvent.prompt() -
Allows a developer to show the install prompt at a time of their own choosing. This method returns a
Promise.
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(choiceResult) { console.log(choiceResult.outcome); // either "accepted" or "dismissed" }, handleError); });
Browser compatibility
| Desktop | Mobile | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Chrome | Edge | Firefox | Internet Explorer | Opera | Safari | WebView Android | Chrome Android | Firefox for Android | Opera Android | Safari on IOS | Samsung Internet | |
BeforeInstallPromptEvent |
44
|
79
|
No
|
No
|
31
|
No
|
44
|
44
|
No
|
32
|
No
|
5.0
|
BeforeInstallPromptEvent |
44
|
79
|
No
|
No
|
31
|
No
|
44
|
44
|
No
|
32
|
No
|
5.0
|
platforms |
44
|
79
|
No
|
No
|
31
|
No
|
44
|
44
|
No
|
32
|
No
|
5.0
|
prompt |
44
|
79
|
No
|
No
|
31
|
No
|
44
|
44
|
No
|
32
|
No
|
5.0
|
userChoice |
44
|
79
|
No
|
No
|
31
|
No
|
44
|
44
|
No
|
32
|
No
|
5.0
|
© 2005–2021 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Web/API/BeforeInstallPromptEvent
