在 VS Code 中尝试

Webview UI 工具包(适用于 Visual Studio Code)

2021 年 10 月 11 日,作者:David Dossett,@david_dossett 和 Hawk Ticehurst,@hawkticehurst

我们非常高兴地宣布 适用于 Visual Studio Code 的 Webview UI 工具包 的公开预览版。通过此工具包,扩展开发者可以快速轻松地在 Visual Studio Code 中创建外观、使用感受和行为都与编辑器本身相似的基于 webview 的扩展

Webview UI Toolkit for Visual Studio Code: gallery view of components

什么是 Webview UI 工具包?

该工具包的核心是一个组件库,开发者可以使用它在扩展 webview 中构建用户界面。请注意,这不会改变我们关于避免在扩展中使用 webview 的建议,除非您绝对需要它们。

该库的功能包括

  • 实现 Visual Studio Code 设计语言:创建与编辑器其余部分具有一致外观和使用感受的扩展。
  • 自动支持颜色主题:所有组件均在设计时考虑了主题,并将自动显示当前编辑器主题。
  • 使用任何技术栈:该库作为一组 Web 组件发布,这意味着无论扩展使用何种技术栈(React、Vue、Svelte 等),开发者都可以使用该工具包。
  • 开箱即用:所有组件都附带符合 Web 标准的 ARIA 标签和键盘导航。

我们为什么要构建它?

我们希望确保使用 webview 的扩展对用户来说是可预测、一致且易于访问的。

每当扩展使用 Webview API 时,创建符合 webview 指南的 UI 的责任在于扩展作者。因此,webview 有可能在外观和行为上与 Visual Studio Code 的其余部分不同。在最坏的情况下,用户必须在与编辑器其余部分完全不同的不可访问的扩展 UI 中进行导航。

有了 Webview UI 工具包,我们现在与扩展作者分担了部分责任。我们可以专注于主题、可访问性以及核心 UI 组件的行为/样式实现的繁琐细节,而您则不必操心。这意味着开发便利性得到提高,开发速度更快,最终有更多时间投入到使您的扩展独一无二的部分!

我们需要您的反馈!

我们迫不及待地希望您试用 Webview UI 工具包!在我们迈向 1.0 版本发布之际,请告诉我们如何改进创建基于 webview 的扩展的体验。

如果您想了解更多信息,可以查阅适用于 Visual Studio Code 的 Webview UI 工具包 文档。此外,如果您有任何疑问、遇到任何问题或有功能请求,请随时联系我们。

祝您编码愉快,

David 和 Hawk