小工具提供者

Windows 小工具是小型的使用者介面容器,用來顯示由 Windows 應用程式或漸進式網頁應用程式(PWA)提供的內容。 你可以提供自適應卡片範本和資料,或使用網頁小工具從網址顯示 HTML。 網頁小工具仍使用 Adaptive Card JSON payload 來指定內容網址。

對於打包式桌面應用程式,你會實作一個小工具提供者,回應小工具主機的請求並透過 WidgetManager 發送更新。 PWA 在其網頁應用程式清單中使用 widget 定義,並在服務工作者中處理 widget 事件。

關於 Windows 小工具體驗的概述及自訂小工具設計指引,請參見 Windows 小工具。

目前您可以使用封裝的 Win32 桌面應用程式或漸進式 Web 應用程式 (PWA) 實作小工具提供者。 如需詳細資訊,請參閱:

桌面小工具提供者的 API 與能力

實作 IWidgetProvider ,用於小工具的建立、刪除、啟用、上下文變更及使用者操作。 當新增自訂或網頁內容的可選介面時,基本介面仍然是必須的。

能力 API 或指引 Availability
小工具生命週期與 Adaptive Card 更新 IWidgetProvider 與 WidgetManager Windows 應用程式 SDK 1.2
使用者自定義 IWidgetProvider2 與 manifest 的 IsCustomizable 屬性 Windows 應用程式 SDK 1.4
網頁內容、資源請求與訊息傳遞 Web widget 提供者、IWidgetResourceProvider、IWidgetProviderMessage 和 WidgetManager.SendMessageToContent Windows 應用程式 SDK 1.6.3;也請檢查網頁小工具主機及區域需求。
表示尚未個人化或可操作的內容 WidgetUpdateRequestOptions.IsPlaceholderContent Windows 應用程式 SDK 1.6.6
Widget 分析回呼 IWidgetProviderAnalytics Windows Widgets Board 從 Windows 11 build 26900 開始支援這些回調。 其他主機也必須支援該介面;請參閱 API 說明。

SDK 版本會標示 API 何時可用,而不是你應該安裝哪個發行版本。 使用目前支援的穩定版,來自 Windows 應用程式 SDK 發佈頻道,並在目標 Windows 裝置和小工具主機上測試你所使用的功能。 關於標頭呈現選項,請參見 「自訂小工具標頭區域」。 PWA 服務工作者 API 是獨立的實作路徑;此表中的桌面介面不適用於此。

小工具主機可以獨立於固定小工具的生命週期之外,啟動並釋放你的提供者。 當提供者開始時還原小工具狀態,且在 IWidgetProvider 回調返回後不要保留回調參數物件。 欲了解更多資訊,請參閱 IWidgetProvider 備註。

完整 API 參考資料請參見 Microsoft.Windows.Widgets.Providers 命名空間。

想了解建立小工具和實作小工具提供者的基本操作,可以觀看 Tabs vs Spaces 節目《Create Widgets for Windows 11》。

其他資源