BeforeInstallPromptEvent: prompt() method
Limited availability
This feature is not Baseline because it does not work in some of the most widely-used browsers.
Experimental:This is anexperimental technology
Check theBrowser compatibility table carefully before using this in production.
Non-standard: This feature is not standardized. We do not recommend using non-standard features in production, as they have limited browser support, and may change or be removed. However, they can be a suitable alternative in specific cases where no standard option exists.
Theprompt() method of theBeforeInstallPromptEvent interface allows a developer to show theinstall prompt at a time of their own choosing. Typically this will be called in the event handler for the app's custom install UI.
This method must be called in the event handler for a user action (such as a button click) and may only be called once on a givenBeforeInstallPromptEvent instance.
Syntax
prompt()Parameters
None.
Return value
APromise resolving to an object containing the following properties:
outcomeExperimentalNon-standardA 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.
platformExperimentalNon-standardIf the user chose to install the app, this is a string naming the selected platform, which is one of the values from the
BeforeInstallPromptEvent.platformsproperty. If the user chose not to install the app, this is an empty string.
Examples
Browser compatibility
See also
- Making PWAs installable
- How to provide your own in-app install experience on web.dev (2021)