Webview
如果需要显示超出 VS Code API 支持范围的自定义功能,可以使用完全可定制的 webview。务必注意,仅在绝对必要时才应使用 webview。
✔️ 应做
- 仅在绝对必要时使用 webview
- 仅在上下文适当时激活扩展
- 仅为活动窗口打开 webview
- 确保视图中的所有元素都可主题化(参见 webview-view-sample 和 颜色 token 文档)
- 确保你的视图遵循 可访问性指南(颜色对比度、ARIA 标签、键盘导航)
- 在工具栏和视图中使用命令操作
❌ 不应做
- 用于促销(升级、赞助等)
- 用于向导
- 在每个窗口都打开
- 在扩展更新时打开(应通过通知询问)
- 添加与编辑器或工作区无关的功能
- 重复现有功能(欢迎页面、设置、配置等)
Webview 示例
简单浏览器
此扩展在编辑器侧边打开浏览器预览。
此示例展示了如何在 VS Code 内开发 VS Code Web。Webview 面板用于呈现类似浏览器的窗口。
拉取请求
此扩展在自定义树视图中显示工作区仓库的拉取请求,然后使用 webview 显示拉取请求的详细信息视图。
Webview 视图
还可以将 webview 放置到任何视图容器(侧边栏或面板)中,这些元素称为 webview 视图。同样的 webview 指南也适用于 webview 视图。
此 webview 视图显示了创建拉取请求的内容,其中使用了下拉列表、输入框和按钮。