BeforeInstallPromptEvent: prompt() method

Limited availability

This feature is not Baseline because it does not work in some of the most widely-used browsers.

See full compatibility

Experimental: This is an experimental technology
Check the Browser 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.

The prompt() method of the BeforeInstallPromptEvent interface allows a developer to show the install 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 given BeforeInstallPromptEvent instance.

Syntax

prompt()

Parameters

None.

Return value

A Promise resolving to an object containing the following properties:

outcome

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

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.

Examples

See the example for the BeforeInstallPromptEvent interface.

Browser compatibility

	desktop					mobile
	Chrome	Edge	Firefox	Opera	Safari	Chrome Android	Firefox for Android	Opera Android	Safari on iOS	Samsung Internet	WebView Android	WebView on iOS
`prompt` Experimental Non-standard	Chrome – Partial support Chrome 44 – 75 (Release date: 2015-07-21) footnote Partial support footnote Resolved with an empty promise. Chrome – Full support Chrome 76 (Release date: 2019-07-30) footnote Full support	Edge – Full support Edge 79 (Release date: 2020-01-15) footnote Full support	Firefox – No support Firefox footnote No support	Opera – Partial support Opera 31 – 62 (Release date: 2015-08-04) footnote Partial support footnote Resolved with an empty promise. Opera – Full support Opera 63 (Release date: 2019-08-20) footnote Full support	Safari – No support Safari footnote No support	Chrome Android – Partial support Chrome Android 44 – 75 (Release date: 2015-07-29) footnote Partial support footnote Resolved with an empty promise. Chrome Android – Full support Chrome Android 76 (Release date: 2019-07-30) footnote Full support	Firefox for Android – No support Firefox for Android footnote No support	Opera Android – Partial support Opera Android 32 – 53 (Release date: 2015-09-23) footnote Partial support footnote Resolved with an empty promise. Opera Android – Full support Opera Android 54 (Release date: 2019-10-18) footnote Full support	Safari on iOS – No support Safari on iOS footnote No support	Samsung Internet – Full support Samsung Internet 5 (Release date: 2016-12-15) footnote Full support	WebView Android – Partial support WebView Android 44 – 75 (Release date: 2015-07-29) footnote Partial support footnote Resolved with an empty promise. WebView Android – Full support WebView Android 76 (Release date: 2019-07-30) footnote Full support	WebView on iOS – No support WebView on iOS footnote No support

Tip: you can click/tap on a cell for more information.

Full support: Full support
Partial support: Partial support
No support: No support
: Experimental. Expect behavior to change in the future.
: Non-standard. Check cross-browser support before using.
: Has more compatibility info.