Webview UI Toolkit 是 VSCode 插件开发中用于构建一致、响应式且主题集成 UI 的专用组件库，需通过 npm 安装、注入资源、启用 Shadow DOM、注册组件、声明式编写 HTML 并处理事件通信。
如果您正在开发 VSCode 插件并希望构建更一致、更响应式且与编辑器视觉风格深度集成的用户界面，则 Webview UI Toolkit 提供了一套专为 VSCode Webview 设计的原生组件与样式系统。以下是使用该工具包构建插件 UI 的具体方法：
本文运行环境：MacBook Pro，macOS Sequoia。
一、安装 Webview UI Toolkit 依赖
Webview UI Toolkit 是一个独立的 NPM 包，需在插件项目中显式引入，以确保组件可被正确加载和渲染。它不内置于 VSCode 运行时，必须通过前端资源注入方式部署到 Webview 中。
1、在插件项目的 package.json 所在目录下执行命令：npm install @vscode/webview-ui-toolkit。
2、确认 node_modules/@vscode/webview-ui-toolkit 目录已成功生成。
3、在插件的 Webview 内容生成逻辑中（如 getWebviewContent 方法），将 toolkit 的 CSS 与 JS 资源路径通过 vscode-webview-resource 协议注入到 HTML 字符串中。
二、在 Webview 中启用 Shadow DOM 并注册组件
Webview UI Toolkit 组件基于自定义元素（Custom Elements）实现，依赖 Shadow DOM 提供样式隔离。若未启用 Shadow DOM，组件将无法正确渲染或响应交互。
1、在 Webview 的 HTML 模板中，为根容器添加 shadow-root="open" 属性，例如：。
2、在注入的 JavaScript 中，调用 customElements.define() 显式注册 toolkit 提供的核心组件，如 vscode-button、vscode-text-field 等。
生成可在 deepbi 沙箱 iframe 内运行或作为独立文件运行的交互式 HTML 页面，使用 `window.deepbi` JS SDK 实现数据查询、空间管理、文件浏览及用户操作。当用户提出以下需求时启用该能力： - 创建 KPI 仪表盘、数据表格、文件浏览器、成员列表、管理页面； - 明确要求“转成 dhtml”、“转译成 HTML”、“把 XX 页面转成……”、“控制台页面”、“管理后台”、“DeepBI 页面迁移”； - 提及位于 `apps/console/src/featur
3、确保注册代码在 Webview DOM 加载完成（DOMContentLoaded）后执行，且早于组件 HTML 片段插入 DOM 的时机。
三、使用声明式语法编写 UI 结构
Toolkit 支持直接在 HTML 中使用语义化标签，无需额外框架绑定。所有组件均遵循 VSCode 设计语言规范，包括颜色、间距、圆角与焦点反馈，能自动适配当前 VSCode 主题（浅色/深色/高对比度）。
1、在 Webview HTML 中写入：
2、添加输入控件：
3、嵌套布局时使用 vscode-panels 或标准 Flex/Grid 容器，避免手动设置 --vscode-* CSS 变量， toolkit 已预置完整主题映射。
四、处理组件事件并与插件主进程通信
Toolkit 组件触发的标准 DOM 事件（如 click、input、change）可直接监听，但需通过 VSCode 的 webview.postMessage() 将用户操作转发至扩展主机进程，以执行实际逻辑。
1、为 vscode-button 添加事件监听：button.addEventListener('click', () => vscode.postMessage({ command: 'saveSettings' }));。
2、对 vscode-text-field 使用 input 事件实时捕获值：textField.addEventListener('input', e => vscode.postMessage({ command: 'updatePath', value: e.target.value }));。
3、在插件主进程的 webview.onDidReceiveMessage 回调中，根据 command 字段分发处理逻辑，避免在 Webview 前端执行敏感操作。
