Skip to content

Bring clarity to PWA manifest requirements needed to use getInstalledRelatedApps #40658

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

ishika-patel
Copy link

Description

This PR clarifies how a web developer can set up the web app manifest for their PWA to leverage getInstalledRelatedApps. This is done by providing an example of the PWAs self identifying related_applications manifest field with the required properties.

Motivation

getInstalledRelatedApps for PWAs has recently shipped in desktop Chrome and Edge. This change will give web developers clarity on what is required of in the setup of their web app manifest to leverage this API.

…Apps

This PR clarifies how a web developer can set up the web app manifest for their PWA to leverage getInstalledRelatedApps. This is done by providing an example of the PWAs self identifying related_applications manifest field.
@github-actions github-actions bot added Content:WebAPI Web API docs size/s [PR only] 6-50 LoC changed labels Aug 6, 2025
Copy link
Contributor

github-actions bot commented Aug 6, 2025

@@ -32,6 +32,23 @@ Defining the relationship is done in a different way depending on the type of ap
- A self-defining entry inside its own `related_applications` manifest member in the case of a PWA checking if it is installed on the underlying platform.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Recommend putting the id requirement here. I think having an example is nice, but if there is requirement for id, we should convey it here and have the example as a supplement (as opposed to conveying it in the example).

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm looking at https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Manifest/Reference/related_applications#values. Is the requirement either url or id, or have to have id?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The requirement for gIRA on PWAs is to have id. However, this is an optional field w.r.t. related_applications in general.

Will update and add the requirement in the Defining relationship section above.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Content:WebAPI Web API docs size/s [PR only] 6-50 LoC changed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants