Vscode 插件开发 - TreeView

树状视图很多插件都可能用到,通常作为一个简单的列表使用,比如管理项目依赖、展示搜索结果。那么 Vscode 的 TreeView 具体怎么玩呢?

基础操作

1.创建视图

在 package.json 的 contributes.views 节点下定义视图:

json 复制代码
{
  "name": "custom-view-samples",
  ...
  "contributes": {
    "views": {
      "my-tree-view": [
        {
          "id": "myTreeView",
          "name": "My Tree View"
        }
      ]
    }
  },
  ...
}

创建视图:

less 复制代码
vscode.window.createTreeView('myTreeView', {});

2.实现树节点

首先实现树节点的数据结构:

typescript 复制代码
class MyTreeItem extends vscode.TreeItem {
  constructor(
    public readonly label: string,
    public readonly collapsibleState: vscode.TreeItemCollapsibleState
  ) {
    super(label, collapsibleState);
    this.tooltip = `MyTreeItem - ${this.label}`;
    this.iconPath = new vscode.ThemeIcon('file');    this.command = {      title: 'Click on me',      command: 'myExtension.myTree.onClick',      arguments: [ { label } ]    };  }
}

vscode.TreeItem 预定义了诸多属性,允许我们控制 TreeItem 的外观与行为:

  • label:用于节点展示文本

  • iconPath:用于设置节点图标,可通过 new vscode.ThemeIcon('file'); 引用 Vscode 内置图标

  • description:节点描述,设置之后将展示在 label 内容之后

  • tooltip:节点提示,当鼠标悬停时展示

  • command:用于设置鼠标点击时绑定的操作,这是一个对象:

  • title:名称

  • command:命令 ID

  • arguments:参数数组

  • collapsibleState:控制节点是否能够展开

  • contextValue:用来控制树状视图的特殊行为,与 action(视图绑定的操作)产生联动,在定义 action 时,通过判断节点 contextValue 来实现在指定节点上绑定操作,如:

    // package.json "contributes": { "menus": { "view/item/context": { "command": "myExtension.myTree.deleteNode", "when": "viewItem == nodeA" // nodeA 为 contextValue } }}

3.为视图提供数据

通过实现vscode.TreeDataProvider为树状视图提供数据,主要实现以下方法:

  • getChildren(element?: T): ProviderResult<T\[\]>;

在加载根节点时,入参为undefined;入参有值时,表示加载该节点的子节点。T 是泛型,需要替换为自己实现的树节点类型。如:

kotlin 复制代码
  getChildren(element?: MyTreeItem): vscode.ProviderResult<MyTreeItem[]> {
    if (element) {
      return Promise.resolve(this.loadItemsOfRootNode());
    } else {
      return Promise.resolve(this.loadItemsUnder(element));
    }
  }

4.注册 TreeDataProvider

通过调用 registerTreeDataProvider 注册视图数据 Provider:

dart 复制代码
vscode.window.registerTreeDataProvider(
  'myTreeDataProvider', // 视图 ID
  new MyTreeDataProvider()
);

或者在创建视图时绑定:

php 复制代码
vscode.window.createTreeView('myTreeView', {  treeDataProvider: new MyTreeDataProvider()});

5.刷新视图

要实现视图刷新,我们需要实现 TreeDataProvider 的事件触发器属性:

  • _onDidChangeTreeData

  • onDidChangeTreeData

这两个属性一个 public 可见,一个 private 可见。实现如下:

typescript 复制代码
private _onDidChangeTreeData: vscode.EventEmitter<Dependency | undefined | null | void> = new vscode.EventEmitter<Dependency | undefined | null | void>();
readonly onDidChangeTreeData: vscode.Event<Dependency | undefined | null | void> = this._onDidChangeTreeData.event;

我们可以通过 _onDidChangeTreeData 触发刷新:

kotlin 复制代码
this._onDidChangeTreeData.fire();

Vscode 在监听到该事件后会重新渲染视图。其他 module 可以访问 onDidChangeTreeData 属性监听刷新事件:

javascript 复制代码
myTreeDataProvider.onDidChangeTreeData(() => { console.log('do something') });

进阶

1.实现拖拽

首先实现 vscode.TreeDragAndDropController,定义如下:

typescript 复制代码
export interface TreeDragAndDropController<T> {  readonly dropMimeTypes: readonly string[];  readonly dragMimeTypes: readonly string[];  handleDrag?(source: readonly T[], dataTransfer: DataTransfer, token: CancellationToken): Thenable<void> | void;  handleDrop?(target: T | undefined, dataTransfer: DataTransfer, token: CancellationToken): Thenable<void> | void;}

dropMimeTypes 和 dragMimeTypes 的值是与树状视图的 id 关联的,也就是用来告诉 Vscode 该控制器只处理从 dragMimeTypes 指定的视图 A 拖拽到 dropMimeTypes 指定的视图 B,如:

csharp 复制代码
dropMimeTypes: readonly string[] = ['application/vnd.code.tree.myExtension_myTreeView'];dragMimeTypes: readonly string[] = ['application/vnd.code.tree.myExtension_myTreeView'];

这里的 'application/vnd.code.tree.myExtension_myTreeView' 对应了 package.json 里定义的:

json 复制代码
"views": {  "automan": [    {      "id": "myExtension.myTreeView",      "name": "MyTreeView"    }  ]},

注意命名转换规则,vscode 对此要求比较严格但官方文档解释又很简略:

  • 点号转换为下划线
  • 点好分割出的每个词必须首字母小写

接下来需要实现 handleDrop 和 handleDrag 的逻辑。handleDrag 为拖拽开始时要做的动作,在这个方法里我们能知道拖拽开始于哪个元素,同时我们需要将数据使用 MIME_TYPE 进行标记、以传递给 handleDrop 方法:

php 复制代码
handleDrag(source: readonly MyTreeItem[], dataTransfer: vscode.DataTransfer, token: vscode.CancellationToken): Thenable<void> | void {  dataTransfer.set(MIME_TYPE, new vscode.DataTransferItem(source));}

接着在 handleDrop 中取出数据,实现移动逻辑:

php 复制代码
handleDrop(target: MyTreeItem | undefined, dataTransfer: vscode.DataTransfer, token: vscode.CancellationToken): Thenable<void> | void {  const transferItem = dataTransfer.get(MIME_TYPE);  if (!transferItem) {    return;  }
  ...
}

将控制器绑定到视图上:

php 复制代码
vscode.window.createTreeView('myTreeView', {  treeDataProvider: new MyTreeDataProvider(),  showCollapseAll: true,  canSelectMany: true,  dragAndDropController: new MyTreeDragAndDropController()});

在创建视图的同时设置 canSelectMany,以允许同时拖拽多个项目。

相关推荐
ServBay6 小时前
Local harness 将退役,VS Code 本地开发要不要搬到云端?
后端·ai编程·visual studio code
DigitalOcean19 天前
不受限于 Copilot,教你在 VS Code 中接入 GPT、Claude
agent·visual studio code
formulahendry24 天前
为什么全世界都在 Fork 它?VS Code 官方纪录片(中字完整版)正式上线!
微软·visual studio code·vs code
三十而立洋1 个月前
知枝 · MindSprout:可以直接将 markdown 转换为思维导图的 vscode 插件
前端·visual studio code
formulahendry1 个月前
在 VS Code 里自由切换 Copilot、Claude、Codex、OpenCode、Pi、Kimi、Qwen:任何 Agent 都能接
visual studio code·vs code·acp
开开心心就好1 个月前
打印机卡住打不了?一键清理卡死打印队列
服务器·开发语言·算法·pdf·ocr·idea·visual studio code
free-elcmacom2 个月前
手撕 memcpy 和 memmove:从字节级拷贝到内存重叠的终极较量
c语言·开发语言·青少年编程·visual studio code·visual studio
free-elcmacom2 个月前
发际线警告!手撕《C陷阱与缺陷》终极 BOSS:signal 函数与 typedef 魔法
c语言·开发语言·visual studio code·visual studio
前端小白乘风2 个月前
VS Code 终于能连微信了!发现一个硬核开源神仙插件:WeChat AHP
微信·visual studio code·deepseek
free-elcmacom2 个月前
C语言指针进阶——指针数组模拟二维数组,以及二级指针到底怎么理解
c语言·visual studio code