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