Interface: WebAppManifest

A manifest is a JSON document that contains startup parameters and application defaults for when a web application is launched.

See

https://w3c.github.io/manifest/#web-application-manifest

Properties

background_color?

optional background_color: string

The WebAppManifest's background_color member describes the expected background color of the web application.

See

https://w3c.github.io/manifest/#dfn-background_color


categories?

optional categories: CategoriesType[]

The categories member is an array of strings that describes the application categories to which the web application belongs.

See

https://w3c.github.io/manifest-app-info/#categories-member


description?

optional description: string

The description member is a string that allows the developer to describe the purpose of the web application. It serves as the accessible description of an installed web application.

See

https://w3c.github.io/manifest-app-info/#description-member


dir?

optional dir: TextDirectionType

The WebAppManifest's dir member specifies the default direction for the localizable members of the manifest. The dir member's value can be set to a TextDirectionType.

See

https://w3c.github.io/manifest/#dfn-dir


display?

optional display: DisplayModeType

The WebAppManifest's display member represents the developer's preferred display mode for the web application.

See

https://w3c.github.io/manifest/#dfn-display


display_override?

optional display_override: ExtendedDisplayModeType[]

For advanced usages, the display_override member can be used to specify a custom fallback order of display mode list values for developers to choose their preferred display mode for the web application. Its value is a display mode.

See


iarc_rating_id?

optional iarc_rating_id: string

The iarc_rating_id member is a string that represents the International Age Rating Coalition (IARC) certification code of the web application.

See

https://w3c.github.io/manifest-app-info/#iarc_rating_id-member


icons?

optional icons: ImageResource[]

The WebAppManifest's icons member are images that serve as iconic representations of the web application in various contexts.

See

https://w3c.github.io/manifest/#dfn-icons


id?

optional id: string

The WebAppManifest's id member is a string that represents the identity for the application. The identity takes the form of a URL, which is same origin as the start URL.

See

https://w3c.github.io/manifest/#dfn-identity


lang?

optional lang: string

The WebAppManifest's lang member is a string in the form of a language tag that specifies the language for the values of the WebAppManifest's localizable members. If the lang member is not specified, the language is treated as unknown.

See

https://w3c.github.io/manifest/#dfn-lang


launch_handler?

optional launch_handler: LaunchHandler

The launch_handler is a dictionary containing configurations for how web app launches should behave.

See

https://wicg.github.io/web-app-launch/#launch_handler-member


name?

optional name: string

The WebAppManifest's name member is a string that represents the name of the web application as it is usually displayed to the user (e.g., amongst a list of other applications, or as a label for an icon).

See

https://w3c.github.io/manifest/#dfn-name


orientation?

optional orientation: "any" | "landscape" | "landscape-primary" | "landscape-secondary" | "natural" | "portrait" | "portrait-primary" | "portrait-secondary"

The WebAppManifest's orientation member is a string that serves as the default screen orientation for all top-level browsing contexts of the web application.

See

https://w3c.github.io/manifest/#dfn-orientation


optional prefer_related_applications: boolean

The WebAppManifest's prefer_related_applications member is a boolean that is used as a hint for the user agent to say that related applications should be preferred over the web application.

See

https://wicg.github.io/manifest-incubations/#prefer_related_applications-member


optional related_applications: ExternalApplicationResource[]

The WebAppManifest's related_applications member lists related applications and serves as an indication of such a relationship between web application and related applications.

See

https://wicg.github.io/manifest-incubations/#related_applications-member


scope?

optional scope: string

The WebAppManifest's scope member is a string that represents the navigation scope of this web application's application context.

See

https://w3c.github.io/manifest/#dfn-scope


screenshots?

optional screenshots: Screenshot[]

The screenshots member is an array of Screenshot, representing the web application in common usage scenarios.

See

https://w3c.github.io/manifest-app-info/#screenshots-member


short_name?

optional short_name: string

The WebAppManifest's short_name member is a string that represents a short version of the name of the web application. It is intended to be used where there is insufficient space to display the full name of the web application.

See

https://w3c.github.io/manifest/#dfn-short_name


shortcuts?

optional shortcuts: ShortcutItem[]

The WebAppManifest's shortcuts member is an list of shortcut items that provide access to key tasks within a web application.

See

https://w3c.github.io/manifest/#dfn-shortcuts


start_url?

optional start_url: string

The WebAppManifest's start_url member is a string that represents the start URL, which is URL that the developer would prefer the user agent load when the user launches the web application (e.g., when the user clicks on the icon of the web application from a device's application menu or homescreen).

See

https://w3c.github.io/manifest/#dfn-start_url


theme_color?

optional theme_color: string

The WebAppManifest's theme_color member serves as the default theme color for an application context.

See

https://w3c.github.io/manifest/#dfn-theme_color