BeforeInstallPromptEvent: userChoice property

Limited availability

The userChoice property of the BeforeInstallPromptEvent interface represents the installation choice that the user made, when they were prompted to install the app.

Value

A Promise which resolves to an object containing two properties:

• outcome Experimental

  • : A string indicating whether the user chose to install the app or not. It must be one of the following values:
    • "accepted": The user installed the app.
    • "dismissed": The user did not install the app.

• platform Experimental

  • : If the user chose to install the app, this is a string naming the selected platform, which is one of the values from the platforms property. If the user chose not to install the app, this is an empty string.

Browser compatibility

See also

• Making PWAs installable
• How to provide your own in-app install experience on web.dev (2021)