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 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.
Returns an array of string 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 choose between a web version or an Android version.
Show a prompt asking the user if they want to install the app. This method returns a Promise that resolves to an object describing the user's choice when they were prompted to install the app.
Examples
In the following example an app provides its own install button, which has an id of "install". Initially the button is hidden.
html
<buttonid="install"hidden>Install</button>
The beforeinstallprompt handler:
Cancels the event, which prevents the browser displaying its own install UI on some platforms
Assigns the BeforeInstallPromptEvent object to a variable, so it can be used later