Conformance

A [=MiniApp manifest=] MUST contain the following members at its root:

• [=app_id=]
• [=icons=]
• [=MiniApp manifest/name=]
• [=pages=]
• [=MiniApp manifest/platform_version=]
• [=version=]

Each [=image resource=] object within the [=MiniApp manifest's=] [=icons=] member MUST contain:

• src

A [=MiniApp manifest=] MAY contain a [=widgets=] member at its root. This member MUST contain an array ([=list=]) of [=MiniApp widget resources=]. Each [=MiniApp widget resource=] object MUST contain the following members:

• [=MiniApp widget resource/name=]
• [=path=]

A [=MiniApp manifest=] MAY contain a [=req_permissions=] member at its root. This member MUST contain an array ([=list=]) of [=MiniApp permission resources=]. Each [=MiniApp permission resource=] object MUST contain the following member:

• [=MiniApp permission resource/name=]

MiniApp user agents MAY implement vendor-specific extensions of the [=manifest=], supporting optional members.

Summary of Members

The following table shows a summary of the [=MiniApp manifest's=] members:

Other [=application manifest=] members such as scope, theme_color, and shortcuts are not currently supported by MiniApp user agents.

Web Application Manifest members

The [=MiniApp manifest=] uses the following essential [=application manifest=]'s members.

Application Information members

The following member is defined in the Web App Manifest - Application Information specification [[MANIFEST-APP-INFO]].

Supplementary members

The following members are defined under the scope of the [=MiniApp manifest=], addressing specific aspects of MiniApp.

            appIdRule = name *("." name)
            name = ALPHA [*( ALPHA / DIGIT / "-" ) ( ALPHA / DIGIT)]
          

Processing the manifest

The MiniApp manifest, as an extension of the [=Application manifest=], provides a supplementary algorithm to be processed at the extension point of the processing a manifest algorithm defined in [[APPMANIFEST]]. Thus, the user agent starts by processing the [=Application manifest=]'s members and, at the extension point, continues with processing the MiniApp manifest members using the following algorithm.

To process a MiniApp manifest at the extension point, given [=ordered map=] |json:ordered map| and [=ordered map=] |manifest:ordered map|:

1. If |manifest|["name"] does not [=map/exist=], [=exception/throw=] a {{TypeError}}.
2. If |manifest|["icons"] does not [=map/exist=], [=exception/throw=] a {{TypeError}}.
3. Let |icons:ordered map| be |manifest|["icons"].
4. If |icons|["src"] does not [=map/exist=], [=exception/throw=] a {{TypeError}}.
5. If |manifest|["icons"] does not [=map/exist=], [=exception/throw=] a {{TypeError}}.
6. Process the app_id member passing |json| and |manifest|.
7. If |manifest|["app_id"] does not [=map/exist=], [=exception/throw=] a {{TypeError}}.
8. Process the color_scheme member passing |json| and |manifest|.
9. Process the description member passing |json| and |manifest|.
10. Process the device_type member passing |json| and |manifest|.
11. Process the pages member passing |json| and |manifest|.
12. If |manifest|["pages"] does not [=map/exist=], [=exception/throw=] a {{TypeError}}.
13. Process the platform_version member passing |json| and |manifest|.
14. If |manifest|["platform_version"] does not [=map/exist=], [=exception/throw=] a {{TypeError}}.
15. Process the req_permissions member passing |json| and |manifest|.
16. Process the version member passing |json| and |manifest|.
17. If |manifest|["version"] does not [=map/exist=], [=exception/throw=] a {{TypeError}}.
18. Process the widgets member passing |json| and |manifest|.
19. Process the window member passing |json| and |manifest|.

min_code member

The [=MiniApp platform version resource's=] min_code member is a non-negative integer number that indicates the minimum supported version of the MiniApp user agent's platform to ensure the regular operation of a MiniApp.

To process the platform version's min_code member, given [=ordered map=] |json:ordered map| and [=ordered map=] |platform_version:ordered map|:

1. If |json|["min_code"] does not [=map/exist=], or if |json|["min_code"] is not a number, return failure.
2. Set |platform_version|["min_code"] to |json|["min_code"].

release_type member

The [=MiniApp platform version resource's=] release_type member is a [=string=] that indicates the release type of the MiniApp user agent's target platform version that is required for running an application.

MiniApp vendors may recommend specific versioning schemes and values for this member (e.g., CanaryN, BetaN, or Release, where N represents a positive integer, such as Beta1).

To process the platform version's release_type member, given [=ordered map=] |json:ordered map| and [=ordered map=] |platform_version:ordered map|:

1. If |json|["release_type"] does not [=map/exist=], or if |json|["release_type"] is not a [=string=], return.
2. Set |platform_version|["release_type"] to |json|["release_type"].

target_code member

The [=MiniApp platform version resource's=] target_code member is a non-negative integer number that indicates the target supported version of the MiniApp user agent's platform to ensure the regular operation of a MiniApp.

To process the platform version's target_code member, given [=ordered map=] |json:ordered map| and [=ordered map=] |platform_version:ordered map|:

1. If |json|["target_code"] does not [=map/exist=], or if |json|["target_code"] is not a number, return.
2. Set |platform_version|["target_code"] to |json|["target_code"].

name member

The [=MiniApp permission resource's=] name member is a [=string=] that indicates the name of the feature requested.

To process the permission resource's name member, given [=ordered map=] |json:ordered map| and [=ordered map=] |permission:ordered map|:

1. If |json|["name"] does not [=map/exist=], or
   if |json|["name"] is not a [=string=], or if |json|["name"] is the empty string, return.
2. Set |permission|["name"] to |json|["name"].

reason member

The optional [=MiniApp permission resource's=] reason member is a [=string=] that indicates the reason given to request the feature specified in the [MiniApp permission resource/name=] attribute.

To process the permission resource's reason member, given [=ordered map=] |json:ordered map| and [=ordered map=] |permission:ordered map|:

1. If |json|["reason"] does not [=map/exist=], or
   if |json|["reason"] is not a [=string=], or if |json|["reason"] is the empty string, return.
2. Set |permission|["reason"] to |json|["reason"].

code member

The [=MiniApp version resource's=] code member is a non-negative integer number that represents the version of a MiniApp. It is mainly used for enhancing the maintainability and security of MiniApp (e.g., compatibility among incremental versions). The [=code=] member aims at supporting the development and deployment process, and it is not usually displayed to the end-user.

To process the version's code member, given [=ordered map=] |json:ordered map| and [=ordered map=] |version:ordered map|:

1. If |json|["code"] does not [=map/exist=], or if |json|["code"] is not a number, return failure.
2. Let |version:number| be a number, initially 1.
3. If |json|["code"] is greater than 0, then:
   Set |version| to |json|["code"].
4. Set |version|["code"] to |version|.

name member

The [=MiniApp version resource's=] name member is a [=string=] mainly used for describing information on the version of a MiniApp, playing an essential role in version control, MiniApp application, and platform compatibility. It is usually considered as the version that is shown publicly and displayed to the user.

The RECOMMENDED format for this member is X.Y.Z, where X, Y, and Z are non-negative integer values (e.g., 1.10.0), as specified in Semantic Versioning [[SEMANTIC-VERSIONING]].

To process the version's name member, given [=ordered map=] |json:ordered map| and [=ordered map=] |version:ordered map|:

1. If |json|["name"] does not [=map/exist=], or if |json|["name"] is not a [=string=], return failure.
2. Set |version|["name"] to |json|["name"].

name member

The [=MiniApp widget resource's=] name member is a [=string=] that indicates the title of a widget.

To process the widget's name member, given [=ordered map=] |json:ordered map| and [=ordered map=] |widget:ordered map|:

1. If |json|["name"] does not [=map/exist=], or if |json|["name"] is not a [=string=], return.
2. Set |widget|["name"] to |json|["name"].

path member

The [=MiniApp widget resource's=] path member is a [=relative-url string=] that defines the corresponding [=page route=] of a widget, represented as in the [=pages=] [=list=].

To process the widget's path member, given [=ordered map=] |json:ordered map| and [=ordered map=] |widget:ordered map|:

1. If |json|["path"] does not [=map/exist=], or if |json|["path"] is not a [=string=], return.
2. Let |url:URL| be the result of [=URL Parser|parsing=] |json|["path"].
3. If |url| is failure, return.
4. Set |widget|["path"] to |url|.

min_code member

The optional [=MiniApp widget resource's=] min_code member is a number that indicates the minimum platform version supported for a MiniApp widget.

Since Widget APIs and MiniApp APIs may differ, the declaration of the minimum version of the platform may be different. Thus, if the widgets member omits [=MiniApp widget resource/min_code=] explicitly, the user agent will consider the same requirement as the specified in the [=MiniApp platform version resource/min_code=] member in the [=platform_version=] object.

To process the widget's min_code member, given [=ordered map=] |json:ordered map|, [=ordered map=] |widget:ordered map| and [=ordered map=] |manifest:ordered map|:

1. Set |widget|["min_code"] to |manifest|["min_code"].
2. If |json|["min_code"] does not [=map/exist=], or if |json|["min_code"] is not a [=string=], return.
3. Set |widget|["min_code"] to |json|["min_code"].

auto_design_width member

The auto_design_width member is a [=boolean=] that indicates whether the [=design_width=] of the page is auto-calculated by the user agent. When [=auto_design_width=] is true, the value of [=design_width=] is ignored. In this case, the system's baseline width is automatically determined according to the pixel density of the screen.

Value by default: false.

To process the window's auto_design_width member, given [=ordered map=] |json:ordered map| and [=ordered map=] |window:ordered map|:

1. If |json|["auto_design_width"] does not [=map/exist=], or if |json|["auto_design_width"] is not a [=boolean=], return.
2. Set |window|["auto_design_width"] to |json|["auto_design_width"].

background_color member

The background_color member is a [=string=] that specifies the background color of the window that contains a MiniApp.

This member supports [=sRGB=] colors, and it is equivalent to the application manifest's background_color.

Value by default: "#ffffff".

When [=processing a MiniApp manifest=], the process a color member algorithm is used to process the window's background_color member, according to the [[APPMANIFEST]] specification.

background_text_style member

The background_text_style member is a [=string=] that specifies the background text style, indicating a light or dark color theme (i.e., "[=background text style values/`light`=]" or "[=background text style values/`dark`=]").

This member supports the values of prefers-color-scheme and MUST contain one of the following background text style values:

"light"

For light style.

"dark" (default)

For dark style.

To process the window's background_text_style member, given [=ordered map=] |json:ordered map| and [=ordered map=] |window:ordered map|:

1. If |json|["background_text_style"] does not [=map/exist=], or
   if |json|["background_text_style"] is not a [=string=], or
   if |json|["background_text_style"] doesn't [=list/contain=] one of the [=background text style values=], return.
2. Set |window|["background_text_style"] to |json|["background_text_style"].

design_width member

The design_width member is a number that indicates the baseline width of the page design in pixel unit. It is used for visually adjusting the page components.

The value is a non-negative integer and the value by default is 750.

To process the window's design_width member, given [=ordered map=] |json:ordered map| and [=ordered map=] |window:ordered map|:

1. If |json|["design_width"] does not [=map/exist=], or
   if |json|["design_width"] is not a number, or if |json|["design_width"] is less than 0, return.
2. Set |window|["design_width"] to |json|["design_width"].

enable_pull_down_refresh member

The enable_pull_down_refresh member is a [=boolean=] that specifies if the pull-to-refresh event is enabled during the interaction with the MiniApp.

Value by default: false.

To process the window's enable_pull_down_refresh member, given [=ordered map=] |json:ordered map| and [=ordered map=] |window:ordered map|:

1. If |json|["enable_pull_down_refresh"] does not [=map/exist=],
   or if |json|["enable_pull_down_refresh"] is not a [=boolean=], return.
2. Set |window|["enable_pull_down_refresh"] to |json|["enable_pull_down_refresh"].

fullscreen member

The fullscreen member is a [=boolean=] that indicates if the MiniApp is shown in full-screen display mode.

When this member takes the true value, it is equivalent to the [=manifest/fullscreen=] value on the application manifest's [=manifest/display=] member. When it takes false as value, it is equivalent to [=display mode/minimal-ui=].

Value by default: false.

To process the window's fullscreen member, given [=ordered map=] |json:ordered map| and [=ordered map=] |window:ordered map|:

1. If |json|["fullscreen"] does not [=map/exist=],
   or if |json|["fullscreen"] is not a [=boolean=], return.
2. Set |window|["fullscreen"] to |json|["fullscreen"].

navigation_bar_background_color member

The navigation_bar_background_color member is a [=string=] that specifies the color of the background of the navigation bar of a MiniApp.

This member supports [=sRGB=] colors.

Value by default: "#000000".

This member is processed according to the specified in [[APPMANIFEST]].

When [=processing a MiniApp manifest=], the process a color member algorithm is used to process the window's navigation_bar_background_color member, according to the [[APPMANIFEST]] specification.

navigation_bar_text_style member

The navigation_bar_text_style member is a [=string=] that indicates the text color of the navigation bar title (i.e., "[=text style values/`white`=]" or "[=text style values/`black`=]").

This member MUST contain one of the following text style values:

"white" (default)

For white text color.

"black"

For black text color.

To process the window's navigation_bar_text_style member, given [=ordered map=] |json:ordered map| and [=ordered map=] |window:ordered map|:

1. If |json|["navigation_bar_text_style"] does not [=map/exist=], or
   if |json|["navigation_bar_text_style"] is not a [=string=], or
   if |json|["navigation_bar_text_style"] doesn't [=list/contain=] one of the [=text style values=], return.
2. Set |window|["navigation_bar_text_style"] to |json|["navigation_bar_text_style"].

navigation_bar_title_text member

The navigation_bar_title_text member is a [=string=] that specifies the title of the navigation bar of a MiniApp.

To process the window's navigation_bar_title_text member, given [=ordered map=] |json:ordered map| and [=ordered map=] |window:ordered map|:

1. If |json|["navigation_bar_title_text"] does not [=map/exist=], or
   if |json|["navigation_bar_title_text"] is not a [=string=], return.
2. Set |window|["navigation_bar_title_text"] to |json|["navigation_bar_title_text"].

navigation_style member

The navigation_style member is a [=string=] that specifies the style of the navigation bar (i.e., "[=navigation style values/`default`=]" or "[=navigation style values/`custom`=]").

This member MUST contain one of the following navigation style values:

"default" (default)

For applying the style by default.

"custom"

For applying a customized navigation bar.

To process the window's navigation_style member, given [=ordered map=] |json:ordered map| and [=ordered map=] |window:ordered map|:

1. If |json|["navigation_style"] does not [=map/exist=], or
   if |json|["navigation_style"] is not a [=string=], or
   if |json|["navigation_style"] doesn't [=list/contain=] one of the [=navigation style values=], return.
2. Set |window|["navigation_style"] to |json|["navigation_style"].

The capsule button at the right corner is not customizable.

on_reach_bottom_distance member

The on_reach_bottom_distance member is a number that defines the vertical offset from the bottom of the window required to trigger a page pull-up event. Values for this member are non-negative integers expressed in [=pixel unit=].

Value by default: 50.

To process the window's on_reach_bottom_distance member, given [=ordered map=] |json:ordered map| and [=ordered map=] |window:ordered map|:

1. If |json|["on_reach_bottom_distance"] does not [=map/exist=], or
   if |json|["on_reach_bottom_distance"] is not a number, or
   if |json|["on_reach_bottom_distance"] is less than 0, return.
2. Set |window|["on_reach_bottom_distance"] to |json|["on_reach_bottom_distance"].

orientation member

The orientation member is a [=string=] that specifies the configuration of the screen orientation for the MiniApp.

This member supports the orientation values: "portrait" and "landscape" defined in {{OrientationLockType}} [[SCREEN-ORIENTATION]].

This member is equivalent to the application manifest's [=manifest/orientation=].

Value by default: "portrait".

To process the window's orientation member, given [=ordered map=] |json:ordered map| and [=ordered map=] |window:ordered map|:

1. If |json|["orientation"] does not [=map/exist=], or
   if |json|["orientation"] is not a [=string=], or
   if |json|["orientation"] doesn't [=list/contain=] one of the [=orientation values=], return.
2. Set |window|["orientation"] to |json|["orientation"].