小组件提供程序

Windows小组件是显示Windows应用或渐进式 Web 应用(PWA)提供的内容的小 UI 容器。 可以提供自适应卡片模板和数据,或使用 Web 小组件从 URL 显示 HTML。 Web 小组件仍使用自适应卡片 JSON 有效负载来指定内容 URL。

对于打包的桌面应用,你实现一个小组件提供程序,该提供程序响应小组件主机的请求,并通过 WidgetManager 发送更新。 PWA 在其 Web 应用清单中使用小组件定义,并处理其 Service Worker 中的小组件事件。

有关 Windows 小组件体验的概述以及创建你自己的小组件的设计指南,请参阅 Windows 小组件。

目前,可以使用打包的 Win32 桌面应用或渐进式 Web 应用 (PWA) 实现组件提供程序。 有关详细信息,请参阅:

桌面小组件提供程序 API 和功能

为小组件创建、删除、激活、上下文更改和用户操作实现 IWidgetProvider 。 添加自定义或 Web 内容的可选接口时,基本接口仍是必需的。

Capability API 或指南 Availability
小组件生命周期和自适应卡片更新 IWidgetProvider 和 WidgetManager Windows 应用 SDK 1.2
用户自定义 IWidgetProvider2 和清单的 IsCustomizable 属性 Windows 应用 SDK 1.4
Web 内容、资源请求和消息传送 Web 微件提供程序、IWidgetResourceProvider、IWidgetProviderMessage和WidgetManager.SendMessageToContent Windows 应用 SDK 1.6.3;还检查 Web 小组件主机和区域要求。
表示尚未个性化或可操作的内容 WidgetUpdateRequestOptions.IsPlaceholderContent Windows 应用 SDK 1.6.6
小组件分析回调 IWidgetProviderAnalytics Windows小组件板支持从 Windows 11 内部版本 26900 开始的这些回调。 其他主机还必须支持接口;请参阅 API 备注。

SDK 版本标识 API 何时可用,而不是应安装哪个发行版。 使用Windows 应用 SDK 发布通道中当前受支持的稳定版本,并测试你在目标 Windows 设备和小组件主机上使用的功能。 有关标头显示选项,请参阅 自定义小组件标头区域。 PWA Service Worker API 是一个单独的实现路径;此表中的桌面接口不适用于它。

小组件主机可以独立于固定小组件的生存期激活并释放提供程序。 在提供程序启动时还原小组件状态,并在 IWidgetProvider 回调返回后不保留回调参数对象。 有关详细信息,请参阅 IWidgetProvider 备注。

有关完整的 API 参考,请参阅 Microsoft.Windows.Widgets.Providers 命名空间。

有关创建小组件和实现小组件提供程序基础知识的入门讲解,请观看 Tabs vs Spaces 节目《为 Windows 11 创建小组件》。

其他资源