BeforeInstallPromptEvent: userChoice property
Experimental: This is an experimental technology
Check the Browser compatibility table carefully before using this in production.
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 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 Non-standard-
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 Non-standard-
If the user chose to install the app, this is a string naming the selected platform, which is one of the values from the
BeforeInstallPromptEvent.platforms
property. If the user chose not to install the app, this is an empty string.
Browser compatibility
BCD tables only load in the browser
See also
- Making PWAs installable
- How to provide your own in-app install experience on web.dev (2021)