在 VS Code 中尝试

Webview

如果你需要显示超出 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 视图显示了用于创建拉取请求的内容,其中使用了下拉菜单、输入框和按钮。