The prefer_related_applications
member is a boolean value that specifies that applications listed in related_applications
should be preferred over the web application.
If the prefer_related_applications
member is set to true
, the user agent might suggest installing one of the related applications instead of this web application.
Currently known possible values for the platform member are as follows;
"chrome_web_store"
: Google Chrome Web Store.
"play"
: Google Play Store.
"chromeos_play"
: Chrome OS Play.
"webapp"
: Web apps.
"windows"
: Windows Store.
"f-droid"
: F-droid.
"amazon"
: Amazon App Store.
The following parameters are not standard and may not work properly on all browsers and systems. Please use with caution.
Progressive Web Apps can opt-in to be pinned to the sidebar in Microsoft Edge.
The sidebar in Microsoft Edge allows users to easily access popular websites and utilities alongside their browser tabs. The content in the sidebar augments the user's primary task by enabling side-by-side browsing and minimizing the need to switch contexts between browser tabs.
You can tell EDGE your PWA should only be loaded in the sidebar and the minimum sidebar size.
The Launch Handler API allows developers to control how your PWA is launched. For example if it uses an existing window or creates a new one, and how the app's target launch URL is handled.
This has one sub-field, client_mode
, which contains a string value specifying how the app should be launched and navigated to.
If not specified, the default client_mode
value is auto
. Available values are:
focus-existing
: The most recently interacted with browsing context in a web app window is chosen to handle the launch. This will populate the target launch URL in the targetURL property of the LaunchParams object passed into the window.launchQueue.setConsumer()'s callback function. As you'll see below, this allows you to set custom launch handing functionality for your app.
navigate-existing
: The most recently interacted with browsing context in a web app window is navigated to the target launch URL. The target URL is still made available via window.launchQueue.setConsumer() to allow additional custom launch navigation handling to be implemented.
navigate-new
: A new browsing context is created in a web app window to load the target launch URL. The target URL is still made available via window.launchQueue.setConsumer() to allow additional custom launch navigation handling to be implemented.
auto
: The user agent decides what works best for the platform. For example, navigate-existing might make more sense on mobile, where single app instances are commonplace, whereas navigate-new might make more sense in a desktop context. This is the default value used if provided values are invalid.
The display_override
property in a PWA manifest allows developers to specify a preferred display mode with fallbacks for cases where a certain display mode is not supported by the platform or browser. This ensures that the best possible display mode is used for the PWA without errors.
In the example below, the browser will consider the following display-mode fallback chain in this order: fullscreen
→ minimal-ui
→ standalone
.
Display override objects are display-mode strings, the possible values are:
Display Mode | Description |
---|
| All of the available display area is used and no user agent UI is shown. |
| The application will look and feel like a standalone application. This can include the application having a different window, its own icon in the application launcher, etc. In this mode, the user agent will exclude UI elements for controlling navigation, but can include other UI elements such as a status bar. |
| The application will look and feel like a standalone application, but will have a minimal set of UI elements for controlling navigation. The elements will vary by browser. |
| The application opens in a conventional browser tab or new window, depending on the browser and platform. This is the default. |
| This display mode only applies when the application is in a separate PWA window and on a desktop operating system. The application will opt-in to the Window Controls Overlay feature, where the full window surface area will be available for the app's web content and the window control buttons (maximize, minimize, close, and other PWA-specific buttons) will appear as an overlay above the web content. |