🚀 在 VS Code 中

Webviews

如果您需要顯示超出 VS Code API 支援的自訂功能,您可以使用完全可自訂的 webview。重要的是要理解,只有在絕對必要時才應使用 webview。

✔️ 建議

  • 僅在絕對必要時才使用 webview
  • 僅在上下文適當時才啟用您的擴充功能
  • 僅為活動視窗開啟 webview
  • 確保檢視中的所有元素都可設定佈景主題(請參閱 webview-view-sample色彩符號 文件)
  • 確保您的檢視遵循 協助工具指南(色彩對比、ARIA 標籤、鍵盤導航)
  • 在工具列和檢視中使用命令動作

❌ 不建議

  • 用於促銷(升級、贊助等)
  • 用於精靈
  • 在每個視窗上開啟
  • 在擴充功能更新時開啟(改為透過通知詢問)
  • 新增與編輯器或工作區無關的功能
  • 重複現有功能(歡迎頁面、設定、組態等)

Webview 範例

簡易瀏覽器

此擴充功能會在編輯器側邊開啟瀏覽器預覽。

Weview sample - Browser

此範例顯示 VS Code Web 正在 VS Code 內部開發。Webview 面板用於呈現類似瀏覽器的視窗。

提取請求

此擴充功能在自訂樹狀檢視中顯示工作區儲存庫的提取請求,然後使用 webview 來顯示提取請求的詳細檢視。

Webview sample - Pull Request

Webview 檢視

您也可以將 webview 放置到任何檢視容器(側邊欄或面板)中,這些元素稱為 webview 檢視。相同的 webview 指南適用於 webview 檢視。

Webview View

此 webview 檢視顯示用於建立提取請求的內容,其中使用下拉式選單、輸入框和按鈕。