在 VS Code 中试试

视图

视图是可显示在侧边栏或面板中的内容容器。视图可以包含树视图、欢迎视图或 Webview 视图,还可以显示视图操作。用户还可以重新排列视图或将其移动到另一个视图容器(例如,从主侧边栏移动到辅助侧边栏)。由于其他扩展可能在同一视图容器中做出贡献,请限制创建的视图数量。

✔️ 推荐

  • 尽可能使用现有图标
  • 对语言文件使用文件图标
  • 使用树视图显示数据
  • 为每个视图添加图标(以防其被移动到活动栏或辅助侧边栏——这两者都使用图标来表示视图)
  • 尽量减少视图数量
  • 尽量缩短名称长度
  • 限制自定义 Webview 视图的使用

❌ 不推荐

  • 重复现有功能
  • 将树项用作单个操作项(例如,单击时触发命令)
  • 如果不必要,请勿使用自定义 Webview 视图
  • 使用活动栏项(视图容器)在编辑器中打开 Webview

Views example

此示例使用树视图来显示树视图项的平面列表。

视图位置

视图可以放置在现有的视图容器中,例如文件资源管理器、源代码管理 (SCM) 和调试视图容器。它们也可以通过活动栏添加到自定义视图容器中。此外,视图可以添加到面板中的任何视图容器。它们也可以被拖到辅助侧边栏。

View locations

视图容器

顾名思义,视图容器是渲染视图的“父”容器。扩展可以将自定义视图容器贡献到活动栏/主侧边栏或面板。用户可以将整个视图容器从活动栏拖到面板(反之亦然),也可以移动单个视图。

Example of a View Container

这是放置在活动栏/主侧边栏中的视图容器示例

Example of a View Container in a Panel

这是放置在面板中的视图容器示例

树视图

树视图是一种强大且灵活的格式,用于在视图中显示内容。扩展可以添加从简单的平面列表到深度嵌套树的任何内容。

  • 使用描述性标签为项目提供上下文(如果适用)
  • 使用产品图标区分项目类型(如果适用)

❌ 不推荐

  • 将树视图项用作触发命令的按钮
  • 除非必要,否则避免深度嵌套。对于大多数情况来说,几层文件夹/项目是一个很好的平衡。
  • 为一个项目添加超过三个操作

Example of a Tree View

欢迎视图

当视图为空时,您可以添加内容来指导用户如何使用您的扩展或开始使用。欢迎视图支持链接和图标。

✔️ 推荐

  • 仅在必要时使用欢迎视图
  • 尽可能使用链接而不是按钮
  • 仅对主要操作使用按钮
  • 使用清晰的链接文本指示链接目标
  • 限制内容长度
  • 限制欢迎视图的数量
  • 限制视图中按钮的数量

❌ 不推荐

  • 如果不必要,请勿使用按钮
  • 使用欢迎视图进行推广
  • 使用通用的“阅读更多”作为链接文本

Welcome Views

此示例显示了扩展的一个主要操作,以及一个指向文档的附加链接。

带进度的视图

您还可以通过引用视图的 ID 在视图中显示进度

View with progress

视图操作

视图可以在视图工具栏上公开视图操作。注意不要添加太多操作,以免造成干扰和混淆。使用内置产品图标有助于扩展融入原生 UI。但是,如果需要自定义图标,可以提供 SVG 图标。

Example of View Actions