使用 GitHub Copilot 创建Windows小组件

可以使用 GitHub Copilot 代理模式或 GitHub Copilot CLI 在现有应用存储库中创建组件。 本文中提供的可复制粘贴的可重用提示指示智能体选择受支持的小组件体系结构,生成所需的源和包注册,构建应用,并在 Windows 小组件板中验证小组件。 本文中包含了提示词,未作为单独可安装的资源提供。

AI 生成的代码仍需要评审。 根据 Microsoft.Windows.Widgets.Providers API 参考验证所选 API,查看每个清单功能和包依赖项,并在提示中不包含机密或生产凭据。

使用提示之前

尽可能多地确定这些需求:

  • 小组件的目的、显示名称和数据源。
  • 内容是否应使用 URL 中的自适应卡片或 HTML。
  • 应用是打包的 C# 桌面应用、打包的 C++/WinRT 桌面应用还是 PWA。
  • 支持的大小:小、中和大。
  • 用户操作、URL 导航和可选自定义设置。
  • 刷新行为、脱机或已注销的回退内容,以及每个小组件的持久状态。
  • 对于桌面提供程序,指定包标识和你打算发布的体系结构。

如果未指定选择,提示会指示Copilot询问会影响体系结构的信息,并对较小的实现细节使用文档中记录的默认值。

可复用的 widget 生成提示

替换方括号中的 widget 请求,然后将完整提示粘贴到 GitHub Copilot 代理模式或交互式 GitHub Copilot CLI 会话中。

Important

提示的可选 CLI 部署路径使用的Windows 应用开发 CLI 目前以公共预览版提供。 在最终发布之前,功能和命令可能会更改。

Create and validate a Windows widget in this repository.

Widget request:
[Describe the widget's purpose, content, data source, supported sizes, actions,
customization, refresh behavior, preferred language, and packaging constraints.]

Work as an implementation agent, not as an advisor. Inspect the existing repository,
create or update the required files, build the selected architecture, deploy a development
package, and test the widget in the Windows Widgets Board when the local environment supports it.

Never report a build, deployment, or Widgets Board check as passed unless you performed it
and observed the result. If you can't operate or observe the Widgets Board, list each
unperformed check under "Manual verification required" with exact steps and expected results.
Do not infer a pass from successful compilation, package registration, or Designer rendering.

Use these requirements:

1. Select exactly one supported implementation path:
   - Packaged C# desktop provider that implements Microsoft.Windows.Widgets.Providers.IWidgetProvider.
   - Packaged C++/WinRT desktop provider that implements IWidgetProvider.
   - PWA widget defined in the web app manifest and handled by its service worker.
   If the request doesn't contain enough information to select a path, ask before creating files.
   Don't mix the PWA service-worker model with the desktop COM provider model.
   Apply desktop-specific API, package, and lifecycle requirements below only to desktop providers.
   For a PWA, use the web app manifest, service-worker, testing, and publishing guidance at:
   https://learn.microsoft.com/microsoft-edge/progressive-web-apps/how-to/widgets

2. For a desktop provider:
   - Use a currently supported stable Windows App SDK release. Verify the package and API names
     against current Microsoft Learn documentation instead of inventing a version.
   - Require package identity. Register the out-of-process COM server and
     com.microsoft.windows.widgets app extension in Package.appxmanifest.
   - Generate one CLSID and use the same value in the provider class, COM factory registration,
     com:Class element, and WidgetProvider/CreateInstance element.
   - Implement CreateWidget, DeleteWidget, OnActionInvoked, OnWidgetContextChanged, Activate,
     and Deactivate.
   - Treat WidgetContext.DefinitionId as the manifest definition and WidgetContext.Id as the
     individual pinned instance. Store and restore state per instance.
   - On process startup, call WidgetManager.GetDefault().GetWidgetInfos() and restore pinned
     instances from CustomState. Make creation and recovery idempotent.
   - Synchronize shared state because provider callbacks can run concurrently.
   - Don't retain callback argument objects after a callback returns.
   - For C# only: follow the documented class-factory pattern. In IClassFactory.CreateInstance,
     obtain a temporary pointer with MarshalInspectable<IWidgetProvider>.FromManaged(new T()),
     query the requested interface with Marshal.QueryInterface, and release the temporary
     pointer in finally. Return HRESULTs at the COM boundary. Use a Windows application output
     type (WinExe) for the final experience so COM activation doesn't open a console window.
   - If the widget is customizable, set IsCustomizable="true" in the widget manifest, implement
     IWidgetProvider2.OnCustomizationRequested, and render a separate customization card. Read
     Adaptive Card input values from WidgetActionInvokedArgs.Data, validate them, and persist
     the resulting settings per widget. Confirm that the COM-callable wrapper exposes every
     provider interface that the class implements.
   - For C++/WinRT: use the walkthrough's non-caching winrt::no_module_lock class factory,
     serialize provider construction, query the requested interface, and translate exceptions
     to HRESULTs at the COM boundary.
   - Send logging to an app-controlled log or debugger output.
   - Target explicit architectures such as x64 and ARM64. Don't use AnyCPU.

3. Select the content model:
   - For an Adaptive Card widget, create a JSON template and a separate JSON data payload.
     Serialize values used as TextBlock text as strings, including numeric counts.
   - For a desktop HTML widget, use the documented web-widget metadata.webUrl payload, provide an
     Adaptive Card fallback, and add IWidgetResourceProvider or IWidgetProviderMessage only
     when the requested scenario needs those APIs.
     Web widgets are available only to users in the European Economic Area (EEA).
     Check regional and host requirements before selecting this path.
   - For a PWA, follow the PWA widget manifest and service-worker documentation instead of
     generating desktop IWidgetProvider code.

4. Implement interaction safely:
   - For a desktop provider, handle Action.Execute in OnActionInvoked. For a PWA, handle it
     through the service worker's widgetclick event.
   - Display Action.Execute only when $host.isUserContextAuthenticated is true.
   - Use Action.OpenUrl for navigation and for an interaction that must remain available when
     the widget user context isn't authenticated.
   - Validate every action verb and input before changing state.
   - Don't put secrets, access tokens, or credentials in the Adaptive Card payload or custom state.

5. Implement responsive and fallback content:
   - For a desktop provider, declare every supported size in Package.appxmanifest.
   - Use $host.widgetSize, $host.hostTheme, and other documented $host properties when needed.
   - Design the small layout separately; don't assume a medium layout will fit.
   - Don't rely on scrolling to reach the widget's primary information. Bound configurable
     collections, and verify that every configured item remains visible in the largest supported
     size. Prefer compact, item-specific links over broad summary links when users need to act
     on individual items.
   - Provide explicit loading, unavailable, offline, and signed-out states that are relevant
     to the requested widget.
   - For a desktop provider, set WidgetUpdateRequestOptions.IsPlaceholderContent when the
     payload isn't yet personalized or actionable.
   - Include accessible display names, descriptions, icon assets, screenshot assets, and
     screenshot alternative text for the widget picker.

6. Keep capabilities and dependencies minimal:
   - Add only the package capabilities required by the widget and its data source.
   - Use HTTPS for remote content.
   - Don't add broad file-system, account, network, or restricted capabilities without a
     requirement and an explanation.

7. Build and deploy:
   - Follow the repository's existing build and packaging structure.
   - For a PWA, follow the PWA widget documentation to test from a public endpoint and package
     with PWABuilder when targeting the Microsoft Store. Don't generate a desktop COM server.
     The Windows App SDK, COM registration, and CLI-first C# steps below are desktop-specific.
   - For a desktop provider, prefer the specific Windows App SDK runtime and widget component
     packages required by the provider over an umbrella dependency when producing a small
     framework-dependent package.
   - Reuse a stable development certificate for local upgrade testing. Don't overwrite a trusted
     certificate on every build. Never publish a private key, PFX, certificate password, token,
     or other secret in source control or release assets.
   - If a public installer trusts a self-signed development certificate, pin the expected public
     certificate thumbprint, verify that it is an unexpired non-CA certificate restricted to code
     signing, and confirm that it signed the MSIX before requesting trust. With explicit user
     consent, install only the public certificate in **Trusted People**. Never add an end-entity
     development certificate to **Trusted Root Certification Authorities**.
   - Increment the package version whenever installing changed MSIX contents. Windows rejects a
     changed package with the same identity and version.
   - The Windows App Development CLI is in public preview. Features and commands may change;
     check the installed version's help before using it.
   - For a CLI-first single-project MSIX C# provider, use EnableMsixTooling=true, keep
     Package.appxmanifest in the provider project, and register a development package with:
       winapp run <project>.csproj --configuration Release --arch x64 --no-launch
     This command registers the package without launching the app. It doesn't verify
     activation or rendering in the Widgets Board.
   - Don't try to replace a development-registered package with an MSIX that uses the same
     identity. Unregister the development package before testing the packaged deployment.
   - Fix build, manifest, registration, and architecture errors before continuing.
   - For a desktop provider, confirm that the registered package contains the windows.comServer
     extension and the com.microsoft.windows.widgets app extension.

8. Validate in the real Widgets Board:
   - Open the board, open the widget picker, and confirm the provider name, widget definition,
     icon, screenshot, and description.
   - Pin the widget and verify the initial template and data.
   - Resize it to every supported size and check for clipping, overlap, overflow, excess empty
     space, and incorrect conditional content.
   - Test every available action and verify the updated data and persisted per-widget settings.
     For desktop providers, verify CustomState.
   - If a desktop widget is customizable, open **Customize widget**, test invalid input, Save,
     and Cancel, and verify that saved settings refresh immediately and survive a host restart.
   - Open item-specific links and verify that each one targets the expected resource rather
     than a broad organization or product page.
   - For a desktop provider, restart the provider process and verify that pinned widget state
     is restored. For a PWA, verify restoration when the service worker activates again.
   - Unpin the widget and verify DeleteWidget for a desktop provider or the widgetuninstall
     service-worker event for a PWA.
   - Don't report interaction success from the Adaptive Cards Designer; it doesn't provide
     Windows $host values or invoke provider callbacks.
   - If the host reports an unauthenticated user context, verify the fallback and clearly
     report that Action.Execute couldn't be exercised in that session.

9. Finish with:
   - A concise list of files created or changed.
   - The selected widget architecture and why it matches the request.
   - Build and deployment results.
   - Observed Widgets Board test results for discovery, rendering, sizes, actions, restart
     persistence, and unpinning. Separate these from "Manual verification required", which
     must list every unperformed check with exact steps and expected results.
   - Any host, account, SDK, or OS limitation that prevented a requested test.

Don't stop after generating snippets. Deliver a buildable implementation and perform the
available validation. Don't invent Windows widget APIs, manifest elements, host properties,
or supported behavior.

查看生成的小组件

在发布结果之前,请查看以下区域:

  • 应用使用正确的 小组件提供程序体系结构 ,并且不会合并不兼容的桌面和 PWA 模式。
  • 桌面提供程序注册遵循 小组件提供程序包清单格式。
  • 该模板仅使用有文档记录的 Windows 小组件主机属性。
  • 小组件处理未经身份验证、不可用和占位符状态,而不会显示不支持的操作。
  • 在 Widgets Board 中呈现并直观地检查了每个支持的大小。
  • 桌面提供程序在重启后还原自定义状态并安全地处理并发回调,或者在服务工作线程激活时 PWA 还原其小组件。
  • 最终应用仅使用其场景所需的功能和依赖项。

有关审查 AI 生成的代码的更多指导,请参阅用于 Windows 开发的安全、负责任的 AI。