MiniApp Widget Requirements

W3C Editor's Draft

More details about this document
This version:
Latest published version:
Latest editor's draft:
Commit history
Yinli Chen (Xiaomi)
Canfeng Chen (Xiaomi)
Bingqing Zhou (Xiaomi)
Bin Guo (Xiaomi)
Former editors:
Xiaowei Jiang (Xiaomi)
Yongqing Dong (Xiaomi)
GitHub w3c/miniapp-widget (pull requests, new issue, open issues)


The MiniApp Widget is a special form of MiniApp Page. Unlike a page, a widget can occupy a certain area instead of the entire screen. It is used to display key information and respond to simple user operations, such as displaying the weather at the user’s current location, or tracking the user’s current travel status and providing further actions.

MiniApp Widget 是 MiniApp 页面的一种特殊形式,与页面不同,Widget 可以仅占用屏幕的部分区域(而不是全部),用于为用户显示关键信息和响应简单的用户操作,例如显示用户所在地的天气,跟踪用户当前的行程状态并提供进一步的操作。

In operating systems or host apps, the MiniApp Widget can be used for many scenarios. In some scenarios, the user can subscribe to a service and the Widget is displayed in a fixed position, while in other scenarios, the Widget can dynamically appear and disappear based on contextual requirements.

在操作系统或者宿主App中,MiniApp Widget 可以被应用于多种场景,某些场景下用户可以订阅和固定显示 Widget,另外一些场景下 Widget 可以根据上下文需求动态地显示和消失。

As the MiniApp Widget is an integral part of MiniApp, the other relevant parts are described in other related MiniApp documents. This document mainly describes the specific requirements that need to be considered when defining the MiniApp Widget Specification as well as other dependencies.

由于 MiniApp Widget 是 MiniApp 的一个组成部分,因此相关的标准部分会在 MiniApp 的其他相关文档中描述,本文档主要描述会专注于定义 MiniApp Widget 规范需要考虑的特定需求和对其他部分依赖的描述。

Status of This Document

This section describes the status of this document at the time of its publication. A list of current W3C publications and the latest revision of this technical report can be found in the W3C technical reports index at

This document was published by the MiniApps Working Group as an Editor's Draft.

Publication as an Editor's Draft does not imply endorsement by W3C and its Members.

This is a draft document and may be updated, replaced or obsoleted by other documents at any time. It is inappropriate to cite this document as other than work in progress.

This document was produced by a group operating under the W3C Patent Policy. W3C maintains a public list of any patent disclosures made in connection with the deliverables of the group; that page also includes instructions for disclosing a patent. An individual who has actual knowledge of a patent which the individual believes contains Essential Claim(s) must disclose the information in accordance with section 6 of the W3C Patent Policy.

This document is governed by the 2 November 2021 W3C Process Document.

1. Usage scenarios 用户场景

  1. In order to quickly check information, users can add favorite MiniApp Widgets in the Widget list of the system, such as weather, calendar, route, etc. When users need further operations, they can click the button on the MiniApp Widget to open the MiniApp Page.

    在系统的Widget列表中,用户可以添加喜欢的 MiniApp Widget,例如天气、日历、行程等,快速查看信息。用户需要更进一步操作时,可以点击MiniApp Widget上的按钮,打开MiniApp页面。

  2. When a user is browsing a video or photo content-type MiniApp, the product in the content is automatically recognized. When the user clicks on this product, the MiniApp Widget related to the e-commerce MiniApp will pop-up. This Widget appears in the form of a floating window, presenting some basic information about the product. Users can click the details button on the Widget to jump to the e-commerce MiniApp Page to purchase.

    用户在浏览视频或者图片类 MiniApp 时,自动识别内容中的商品。当用户点击这个商品时,打开电商 MiniApp 相关的 MiniApp Widget。这个 Widget 可以浮窗形式出现,呈现商品的一些基本信息。用户可以点击Widget上的详情按钮,跳转到电商MiniApp的页面来购买。

  3. When the user asks the voice assistant, such as asking about the exchange rate, the voice assistant opens the MiniApp Widget related to the exchange rate and presents relevant information.

    用户询问语音助手时,例如询问汇率,语音助手打开汇率相关的MiniApp Widget,呈现相关信息。

2. Requirement 需求

2.1 User agent 宿主环境

The MiniApp Widget runs in a host environment that is called the user agent. The MiniApp Widget user agent is largely the same as the MiniApp user agent, and shall meet the following requirements:

MiniApp Widget 需要在一个宿主环境中运行,这个环境被称为 user agent。MiniApp Widget 的 user agent 在较大程度下与 MiniApp 的 user agent 保持一致,应该满足如下一些需求:

  1. The MiniApp Widget user agent should be able to parse the MiniApp URI and obtain the MiniApp package according to the process described in the MiniApp Addressing specification, and it shall conform to the requirements in the Dereferencing section of the MiniApp Addressing specification.

    MiniApp Widget 的 user agent 应当能根据 MiniApp Addressing 规范中描述的过程解析 MiniApp URI 并获取 MiniApp 包,该过程应当符合 MiniApp Addressing 规范中解引用一节描述。

  2. The user agent should be able to parse the structure of the MiniApp package as described in the MiniApp Packaging specification.

    User agent 应当能按照 MiniApp Packaging 规范的描述解析 MiniApp 包结构。

  3. The user agent should be able to parse the manifest file as described in the MiniApp Manifest specification, so as to load and run the MiniApp Widget. Some specific requirements related to the Widget are described in the Manifest File section of this document.

    User agent 应当能按照 MiniApp Manifest 规范的描述解析 manifest 文件,以加载运行 MiniApp Widget。在本文档的 Manifest 文件一节中描述了一些与 Widget 相关的特定需求。

  4. The form of resources that the MiniApp Widget accesses in the package is consistent with a MiniApp page. Therefore, the user agent should be able to access the resource files in the MiniApp package in the same way.

    MiniApp Widget 访问到包中的资源形式与 MiniApp 页面保持一致。因此,user agent 应能以同样的方式访问 MiniApp 包中的资源文件。

  5. When running the widget, the user agent should be able to provide necessary interface support. Some specific requirements related to the Widget are described in the MiniApp API section of this document.

    在运行过程中,user agent 应能提供必要的接口支持,在本文档的 MiniApp API 一节中描述与 Widget 相关的特定需求。

Specifically, in the MiniApp Widget scenario, as the Widget itself does not occupy the complete screen space, the user agent will have some specific requirements:

特定地,在 MiniApp Widget 场景下,由于 Widget 本身并不占据完整的屏幕空间,user agent 也会有一些特定的需求:

  1. The user agent can integrate the MiniApp Widget with its own interface, to achieve a better integration experience.

    User agent 可以将 MiniApp Widget 与自身界面结合在一起显示,以达到更好的融合体验。

  2. To better integrate the MiniApp Widget and the user agent interface, the user agent should provide its style information to the MiniApp Widget, so as to better support the requirements such as dark mode.

    为了更好地将 MiniApp Widget 与 user agent 的界面融合,user agent 应当为 MiniApp Widget 提供自身样式的信息,以更好的支持诸如深色模式等需求。

  3. The user agent should be able to load and display multiple MiniApp Widgets concurrently, for example, display a relevant air ticket Widget and taxi Widget simultaneously on Intelligent Assistant.

    User agent 可以同时加载并显示多个 MiniApp Widget,例如在智能助理中同时显示相关的机票 Widget 和打车 Widget。

  4. Some behaviors of the User agent may cause the Widget to show or hide, and in such a case, the lifecycle callback of the Widget should be triggered correctly.

    User agent 的一些行为可能会导致 Widget 的展现和消失,此时应该正确触发 Widget 的生命周期回调。

2.2 URI

The MiniApp Widget URI should be consistent with the MiniApp Addressing specification, to ensure that:

MiniApp Widget 的 URI 规范应该与 MiniApp Addressing 规范保持一致,以确保:

  1. The user agent can obtain the MiniApp package containing the MiniApp Widget using the same mechanism.

    User agent 能以相同的机制获取包含 MiniApp Widget 的 MiniApp 包。

  2. The user agent can locate and load the MiniApp Widget using the same mechanism as the MiniApp Page.

    User agent 能以与 MiniApp 页面相同的机制定位并加载 MiniApp Widget。

2.3 Packaging

Like MiniApp, the MiniApp Widget is also distributed in the form of a package. After the user agent acquires and verifies a MiniApp package, it will acquire the Widget information contained in the package, and load and display it correctly. The form and specification of the package should be consistent with the MiniApp Packaging specification, including but not limited to file organization, compression format, filename extension, digital signature, etc. The user agent should use the same form to verify and install the MiniApp Widget package.

与 MiniApp 保持一致,MiniApp Widget 同样以包的形式分发,User agent 获取到 MiniApp 包并进行校验后,获取包中包含的Widget信息,并正确地加载和显示。包的形式和规范应当与 MiniApp Packaging 规范保持一致。包括不限于文件组织形式、压缩格式、文件后缀名、数字签名等。User agent 会以同样的形式对 MiniApp Widget 的包进行校验、安装等过程。

In the MiniApp Widget scenario, the specific requirements are as follows:

在 MiniApp Widget 场景下,特定的需求:

  1. A MiniApp package may contain both the MiniApp Pages and Widgets. In some cases, MiniApp expects to display a Widget on the user agent, however, when the user clicks the content on the Widget, a MiniApp Page is provided as the landing page with richer content.

    一个 MiniApp 包中应该可以同时包含 MiniApp 页面和 Widget。在某些情况下,MiniApp 希望能在 user agent 上 显示一个 Widget,并在用户点击Widget上的内容时,提供 MiniApp 页面作为承载更丰富内容的落地页。

  2. A MiniApp package may contain only Widgets without Pages. Some MiniApp providers just want to provide simplest functions on the Widget to meet the users’ specific needs.

    一个 MiniApp 包中应该可以只包含 Widget,不包含 Page。某些 MiniApp 的提供方只希望在 Widget 上提供最简单的功能,以满足用户的特定需求。

2.4 Manifest File Manifest 文件

The configuration file must be included in the MiniApp Widget package. Developers can set the basic information, style, and routing of the Widget through the Manifest file. The format of the Widget Manifest file should be consistent with that of the MiniApp Manifest file. Specifically, there will be some changes in the Widget environment.

MiniApp Widget 包中需要包含配置文件,开发者可通过 Manifest 文件设置 Widget 的基本信息、样式和路由等信息。Widget 的 Manifest 文件应当与 MiniApp Manifest 文件的格式保持一致。特定地,在 Widget 环境中,会有一些变化:

Widget Description Widget 描述

The Manifest file should include a widgets property (similar to the pages property), used for designating relevant information and configuration of widget contained in MiniApp, and should include the following:

Manifest 文件中需要包含 widgets 字段(类似于 pages 字段),用于指定 MiniApp 中包含的 widget 的相关信息和配置,应当包含以下:

  1. Name of the MiniApp Widget

    MiniApp Widget 的名字

  2. File path of the MiniApp Widget – used for locating the file where the MiniApp Widget is located

    MiniApp Widget 的文件路径,用于定位 MiniApp Widget 所在的文件

  3. Minimum platform version. Different minimum platform version declarations may exist as there may be differences between the Widget API and MiniApp API. As the Widget is loaded independently, the minimum platform version declaration can be directed for a single widget

    最小平台版本,因为 Widget 涉及的 API 与 MiniApp API 有一定差别,可能会存在不同的最小平台版本声明。且因为 Widget 是独立加载的,最小平台版本声明可以针对单个 widget 声明

Field changes in Manifest file Manifest 文件字段变化

Due to some features of the widget, some configuration information in the Manifest file will not take effect in widgets. For example, the fullScreen property of window describes whether the MiniApp Page is displayed in fullscreen, however, as the widget has no fullscreen mode, this property will be ignored.

因为 widget 的一些特点,Manifest 文件中的一些配置信息,在 Widget 中不会生效。例如 windowfullScreen 属性,描述了 MiniApp 页面是否以全屏形式显示,由于 widget 并没有对应的形式,因此会忽略这个信息。

2.5 Lifecycle

The lifecycle of the MiniApp Widget should be consistent with the MiniApp Lifecyle, wherein the trigger timing of onShow/onHide lifecycle callback will have some changes. As the Widget may also show or hide when the user agent slides the Widget off the screen or conducts a collapse action, the onShow/onHide of the Widget should also be triggered correctly at this time. Due to the form of the Widget and the form it runs in the user agent, the Widget also needs to support some new lifecycle API:

MiniApp Widget 的生命周期应该与 MiniApp 页面的生命周期保持一致,其中 onShow/onHide 生命周期回调的触发时机会有一些变化。因为 Widget 的出现和消失也可能发生在 user agent 将 Widget 滑出屏幕或者进行折叠操作时,此时 Widget 的 onShow/onHide 也应该被正确的触发。因为 Widget 的形态和在宿主环境中运行的形式,Widget 也需要支持一些新的生命周期 API:

  1. In case of changes in system language, window size, color scheme etc., the Widget needs to receive the changed information to change the interface.

    当系统语言/窗口大小/Darkmode 等发生变化时,Widget 需要接收到变化后的信息,以改变界面。

  2. The user agent may update the status of the Widget interface in the form of incoming data; Widget reinitialization should not be triggered at this time.

    宿主环境可能会通过传入数据的形式更新 Widget 界面的状态,此时不应该触发 Widget 的重新初始化。

2.6 MiniApp API

The API that developers can use in the MiniApp Widget should be consistent with the [MiniApp API specification] as much as possible, however, some APIs need to be adjusted for specific MiniApp Widget scenarios. The content in this section should be adjusted based on the [MiniApp API specification].

开发者在 MiniApp Widget 中可以使用的API 应当与 [MiniApp API 规范] 尽量保持一致,但有一些 API 需要针对 MiniApp Widget 场景进行调整,本节内容应根据 [MiniApp API 规范] 内容调整。

Some APIs that could be used on MiniApp Page need to be adjusted in Widget scenario, such as:

在 Widget 场景下,一些原先在 MiniApp 页面上可以使用的 API 需要调整,例如:

  1. API with background persistence or API passively triggered, e.g. background location and push. As the Widget runs in the user agent, it does not exist as an independent unit in terms of user perception, and these APIs are prone to cause user confusion between calling the Widget and the user agent.

    具备后台持续能力或者被动触发的 API,例如持续定位和推送,因为 Widget 在 user agent 环境中运行,在用户认知上并不作为独立运行的单元存在,这些 API 易造成用户将 Widget 的调用与 user agent 混淆。

  2. API that can capture user attention and cause misunderstanding by the user, e.g. launching the camera interface. As multiple Widgets may be displayed on the same interface, if these Widgets directly call the API to open the interface concurrently, it will cause the user to misunderstand.

    会抢占用户注意力,造成用户错误认知的 API,例如打开拍照界面等,由于多个 Widget 可能会同时显示在一个界面上,如果多个 Widget 均直接调用打开界面的 API,会造成用户理解上的错误。

The User agent should provide some new APIs suitable for the Widget, for example:

User agent 会提供一些适用于 Widget 的新 API,例如:

  1. API to obtain the current window size (viewport width)

    获取当前窗口大小的 API(视口宽度)

  2. API to obtain the current user agent information, to enable the Widget to adapt to the specific user agent

    获取当前 user agent 信息的 API,以支持 Widget 针对特定的 user agent 进行适配

  3. Pre-authorized APIs in a batch. As there may be multiple MiniApp Widgets on the user agent concurrently, multiple APIs that dynamically obtain permission will cause user confusion. Thus, the user agent should provide pre-authorized APIs in a batch.

    批量预授权的 API,由于 user agent 上可能同时存在多个 MiniApp Widget,出现多个动态获取权限的 API 会对用户造成困扰,user agent 应提供批量预授权的 API

  4. Extended APIs for specific user agents, e.g., request to obtain the latest version of the Widget

    特定宿主环境的拓展 API,例如请求获取到最新版本的 Widget

2.7 MiniApp Components MiniApp 组件

The components that developers can use in the Widget should be consistent with the [MiniApp component specification] as much as possible, however, some components need to be adjusted for specific Widget scenarios. The content in this section should be adjusted based on the [MiniApp component specification].

开发者在 Widget 中可以使用的组件应当与 [MiniApp 组件规范] 尽量保持一致,但有一些组件需要针对 Widget 场景进行调整,本节内容应根据 [MiniApp 组件规范] 内容调整。

The behavior of some components may conflict with the behavior of the user agent, for example:

一些组件的行为可能与 user agent 的行为发生冲突,例如:

  1. If some Widgets include a relatively long scrollable list, it may conflict with the sliding up and down operation of the user agent

    某些 Widget 中如果包含较长的滚动列表,可能与 user agent 的上下滑动操作发生冲突

2.8 Data communication between MiniApp Widget and MiniApp MiniApp Widget 和 MiniApp 之间的数据通信

Under certain circumstances, the Widget needs to maintain certain data communication with MiniApp, for example:

在一定情况下,Widget 需要与 MiniApp 保持一定的数据通信,例如:

  1. If already logged in MiniApp, the same login status is maintained in the Widget.

    在 MiniApp 中已经登录,在 Widget 保持同一登录状态

  2. If a MiniApp is playing music, the Widget gets the playing status to show playback control.

    MiniApp 播放音乐,Widget 获取播放状态以显示播放控件

Therefore, the specifications should include a description of data communication between the MiniApp Widget and MiniApp.

因此规范中应补充 MiniApp Widget 与 MiniApp 之间数据通信的描述。

A. References 参考

  1. Requirement For Standardizing Widgets
  2. Widget related Recommendations are W3C Obsolete Recommendations

    W3C Widget 标准废弃说明

  3. MiniApp Specifications
  4. MiniApp Manifest
  5. MiniApp Addressing
  6. MiniApp Lifecycle
  7. MiniApp Packaging