Widgets
Windows小组件是与已安装的应用关联的小型 UI 容器。 小组件板在 Windows 桌面上以网格形式显示它们,并包含来自应用的个性化内容和快速操作。 可以使用 自适应卡片 定义内容,它可将数据绑定到 JSON 模板,或者通过 Web 小组件提供程序 显示来自 URL 的 HTML。 Web 小组件仍使用自适应卡片 JSON 有效负载来指定内容 URL。
有关设计指南,请参阅 Windows 小组件设计概述。
选择小组件开发路径
使用此表选择要打开的实现路径和下一主题。
| 如果你希望... | 使用此方法 | 从这里开始 |
|---|---|---|
| 将自适应卡片小组件添加到打包的 C# 桌面应用 | 实现 IWidgetProvider,使用 WidgetManager 发送模板和数据更新,并通过包清单注册提供程序。 | C# 小组件提供程序演练 |
| 将自适应卡片小组件添加到打包的 C++/WinRT 桌面应用 | 在进程外 COM 服务器中实现 IWidgetProvider ,并在包清单中注册其 CLSID 和小组件定义。 | C++/WinRT 小组件提供程序演练 |
| 在桌面小组件内显示来自 URL 的 HTML | 使用 Web 小组件提供程序。 此功能仅对位于欧洲经济区(EEA)的用户可用。 提供程序仍发送包含 Web URL 和回退内容的自适应卡片有效负载。 | 网页组件提供程序 |
| 为现有渐进式 Web 应用 (PWA) 添加小组件 | 在 Web 应用清单中定义小组件,并在服务工作线程中处理小组件事件。 这与桌面 IWidgetProvider 路径是分开的。 | 生成 PWA 驱动的小组件 |
| 在桌面提供程序中处理按钮或表单操作 | 使用 Action.Execute 并在 OnActionInvoked 中处理 verb。 仅当为 true 时才 $host.isUserContextAuthenticated 显示它。 |
创建小组件模板 |
| 在没有提供方回调的情况下打开应用页面或网站 | 使用 Action.OpenUrl。 当小组件用户上下文未进行身份验证时,这仍然可用。 | 创建小组件模板 |
| 让用户配置小组件 | 实现 IWidgetProvider2,设置清单的 IsCustomizable 属性,并提供自定义有效负载。 | 实现小组件自定义 |
| 调整内容以适应大小、主题、设置、标头、Web 支持或身份验证 | 在自适应卡片模板中使用Windows$host属性,并在包清单中声明每个受支持的大小。 |
Windows小组件主机属性 |
| 显示加载中或未登录内容 | 发送有意的回退模板和数据。 在内容尚未个性化或可操作时设置 IsPlaceholderContent 。 | 小组件提供程序 |
| 添加仪表板信息源而不是单个小组件 | 实现订阅源提供程序。 Feed 提供商是单独的集成,仅在欧洲经济区(EEA)提供。 | 仪表板和源提供方 |
| 让 GitHub Copilot 创建和验证小组件 | 使用可重用的提示,该提示词会选择受支持的路径,并需要完成包、清单、生成和小组件板验证。 | 使用 GitHub Copilot 创建 Windows 小组件 |
Dashboards
源提供程序负责注册内容源,这些内容源在小组件板中显示为仪表板。 订阅源提供程序是独立于小组件提供程序的集成;在小组件内显示 HTML 不会注册仪表板订阅源。
Important
Feed 提供商仅适用于欧洲经济区(EEA)中的用户。 有关可用性和实现要求,请参阅 仪表板和源提供程序。
本节内容
| 主题 | 说明 |
|---|---|
| 信息提供者 | 了解如何注册应用的内容源,以直接显示在Windows组件板中。 |
| 小组件提供程序 | 了解如何实现一个小组件提供者,以便为您的小组件提供内容、布局和交互式元素。 |
| 网页组件提供程序 | 在小组件中显示 HTML,处理提供程序和 Web 内容之间的资源请求和消息。 |
| 自适应卡片设计器 | 逐步演示如何使用自适应卡片设计器创建小组件模板。 |
| 使用 GitHub Copilot 创建 Windows 小组件 | 使用可重用的提示在现有存储库中生成、打包并验证小组件。 |