The
BeforeInstallPromptEvent
is fired at the Window.onbeforeinstallprompt
handler before a user is prompted to "install" 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="/docs/Web/API/Event" target="_top"><rect x="1" y="1" width="75" height="50" fill="#fff" stroke="#D4DDE4" stroke-width="2px" /><text x="38.5" y="30" font-size="12px" font-family="Consolas,Monaco,Andale Mono,monospace" fill="#4D4E53" text-anchor="middle" alignment-baseline="middle">Event</text></a><polyline points="76,25 86,20 86,30 76,25" stroke="#D4DDE4" fill="none"/><line x1="86" y1="25" x2="116" y2="25" stroke="#D4DDE4"/><a xlink:href="/docs/Web/API/BeforeInstallPromptEvent" target="_top"><rect x="116" y="1" width="240" height="50" fill="#F4F7F8" stroke="#D4DDE4" stroke-width="2px" /><text x="236" 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()
- Creates a new
BeforeInstallPromptEvent
.
Properties
Inherits properties from its parent, Event
.
BeforeInstallPromptEvent.platforms
Read only- Returns an array of
DOMString
items 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 chose between a web version or an Android version. BeforeInstallPromptEvent.userChoice
Read only- Returns a
Promise
that resolves to aDOMString
containing 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
The compatibility table on this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
Desktop | Mobile | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
BeforeInstallPromptEvent | Chrome Full support 45 | Edge Full support ≤79 | Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android Full support 45 | Chrome Android Full support 45 | Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android Full support 5.0 |
BeforeInstallPromptEvent() constructor | Chrome Full support 45 | Edge Full support ≤79 | Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android Full support 45 | Chrome Android Full support 45 | Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android Full support 5.0 |
platforms | Chrome Full support 45 | Edge Full support ≤79 | Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android Full support 45 | Chrome Android Full support 45 | Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android Full support 5.0 |
prompt | Chrome Full support 45 | Edge Full support ≤79 | Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android Full support 45 | Chrome Android Full support 45 | Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android Full support 5.0 |
userChoice | Chrome Full support 45 | Edge Full support ≤79 | Firefox No support No | IE No support No | Opera No support No | Safari No support No | WebView Android Full support 45 | Chrome Android Full support 45 | Firefox Android No support No | Opera Android No support No | Safari iOS No support No | Samsung Internet Android Full support 5.0 |
Legend
- Full support
- Full support
- No support
- No support
- Experimental. Expect behavior to change in the future.
- Experimental. Expect behavior to change in the future.
- Non-standard. Expect poor cross-browser support.
- Non-standard. Expect poor cross-browser support.