0

0

如何为VSCode的Webview创建自定义UI

P粉986688829

P粉986688829

发布时间:2026-01-05 12:53:03

|

962人浏览过

|

来源于php中文网

原创

Webview 是 VSCode 扩展中实现富交互前端界面的核心机制,支持内联 HTML/CSS/JS、本地静态资源、React 构建产物及官方 Webview UI Toolkit 四种定制化方案。

如何为vscode的webview创建自定义ui

如果您在开发 VSCode 扩展时需要向用户展示富交互的前端界面,Webview 是核心机制;但默认 Webview 缺乏样式控制与结构化 UI 组件支持,需手动集成现代前端方案实现定制化视觉与行为。以下是实现自定义 UI 的多种方法:

本文运行环境:MacBook Pro,macOS Sequoia。

一、使用内联 HTML + CSS + JavaScript 直接注入

此方法通过 webview.html 属性直接拼接完整 HTML 字符串,将样式与脚本内联嵌入,适合轻量、静态且无需构建流程的 UI 场景。

1、在扩展主文件中调用 vscode.webviewView.createWebviewPanel 或 vscode.window.createWebviewPanel 创建 webview 实例。

2、设置 webview.options 启用本地资源加载权限,包括 enableScripts: true 和 localResourceRoots。

3、为 webview.html 属性赋值,字符串中包含

4、在 script 中通过 window.acquireVsCodeApi() 获取通信句柄,调用 postMessage 向扩展主线程发送事件。

关键点:所有 CSS 必须使用内联方式或

二、启用本地静态资源服务并引用外部文件

该方式将 HTML、CSS、JS 分离为独立文件,通过 webview.asWebviewUri 转换路径,使资源可被 webview 安全加载,利于维护与复用。

1、在扩展目录下创建 webview/ 子文件夹,放入 index.html、style.css、main.js

2、在 webview 实例创建后,调用 asWebviewUri 方法转换各资源路径,例如 this._extensionUri.with({ path: 'webview/style.css' })。

3、在 index.html 中使用转换后的 URI 引入资源,如

4、确保 webview.options.localResourceRoots 包含 webview 文件夹的 Uri,否则资源 404。

关键点:路径必须经 asWebviewUri 处理,原始 file:// 协议地址会被 webview 拦截

云模块网站管理系统3.1.03
云模块网站管理系统3.1.03

云模块_YunMOK网站管理系统采用PHP+MYSQL为编程语言,搭载自主研发的模块化引擎驱动技术,实现可视化拖拽无技术创建并管理网站!如你所想,无限可能,支持创建任何网站:企业、商城、O2O、门户、论坛、人才等一块儿搞定!永久免费授权,包括商业用途; 默认内置三套免费模板。PC网站+手机网站+适配微信+文章管理+产品管理+SEO优化+组件扩展+NEW Login界面.....目测已经遥遥领先..

下载

三、集成 React 构建的组件系统

利用 create-react-app 或 Vite 构建前端工程,生成静态产物后复制至扩展资源目录,再通过 webview 加载,适用于复杂表单、树形控件或状态管理需求。

1、新建 React 项目,安装 @vscode/webview-ui-toolkit 以获得官方按钮、输入框等 Web Component。

2、编写 JSX 组件,使用 toolkit 元素如 确认

3、执行构建命令(如 npm run build),将 dist/ 内容整体拷贝至扩展的 webview/dist/ 目录。

4、在扩展代码中读取 dist/index.html 内容,替换占位符为真实 asWebviewUri 路径后赋给 webview.html。

关键点:React 应用必须配置 publicPath 为 '',且不依赖 history 路由,推荐使用 HashRouter

四、使用 Webview UI Toolkit 原生组件库

VSCode 官方提供的 Web Component 库,无需框架即可在纯 HTML 中使用语义化 UI 元素,并自动适配深色/浅色主题及字体缩放。

1、在 webview HTML 字符串中添加 toolkit 的 CDN 链接:

2、在 body 中直接使用 等标签。

3、通过 CSS 自定义属性调整尺寸与间距,例如 --vscode-font-size: 13px; --vscode-spacing: 4px;。

4、监听组件原生事件,如 text-field 的 input 事件,结合 acquireVsCodeApi 发送数据到扩展进程。

关键点:CDN 方式无需构建,但需确保网络可达;离线场景应下载 toolkit.esm.js 至本地并 asWebviewUri 加载

相关专题

更多
js获取数组长度的方法
js获取数组长度的方法

在js中,可以利用array对象的length属性来获取数组长度,该属性可设置或返回数组中元素的数目,只需要使用“array.length”语句即可返回表示数组对象的元素个数的数值,也就是长度值。php中文网还提供JavaScript数组的相关下载、相关课程等内容,供大家免费下载使用。

547

2023.06.20

js刷新当前页面
js刷新当前页面

js刷新当前页面的方法:1、reload方法,该方法强迫浏览器刷新当前页面,语法为“location.reload([bForceGet]) ”;2、replace方法,该方法通过指定URL替换当前缓存在历史里(客户端)的项目,因此当使用replace方法之后,不能通过“前进”和“后退”来访问已经被替换的URL,语法为“location.replace(URL) ”。php中文网为大家带来了js刷新当前页面的相关知识、以及相关文章等内容

373

2023.07.04

js四舍五入
js四舍五入

js四舍五入的方法:1、tofixed方法,可把 Number 四舍五入为指定小数位数的数字;2、round() 方法,可把一个数字舍入为最接近的整数。php中文网为大家带来了js四舍五入的相关知识、以及相关文章等内容

729

2023.07.04

js删除节点的方法
js删除节点的方法

js删除节点的方法有:1、removeChild()方法,用于从父节点中移除指定的子节点,它需要两个参数,第一个参数是要删除的子节点,第二个参数是父节点;2、parentNode.removeChild()方法,可以直接通过父节点调用来删除子节点;3、remove()方法,可以直接删除节点,而无需指定父节点;4、innerHTML属性,用于删除节点的内容。

471

2023.09.01

JavaScript转义字符
JavaScript转义字符

JavaScript中的转义字符是反斜杠和引号,可以在字符串中表示特殊字符或改变字符的含义。本专题为大家提供转义字符相关的文章、下载、课程内容,供大家免费下载体验。

394

2023.09.04

js生成随机数的方法
js生成随机数的方法

js生成随机数的方法有:1、使用random函数生成0-1之间的随机数;2、使用random函数和特定范围来生成随机整数;3、使用random函数和round函数生成0-99之间的随机整数;4、使用random函数和其他函数生成更复杂的随机数;5、使用random函数和其他函数生成范围内的随机小数;6、使用random函数和其他函数生成范围内的随机整数或小数。

990

2023.09.04

如何启用JavaScript
如何启用JavaScript

JavaScript启用方法有内联脚本、内部脚本、外部脚本和异步加载。详细介绍:1、内联脚本是将JavaScript代码直接嵌入到HTML标签中;2、内部脚本是将JavaScript代码放置在HTML文件的`<script>`标签中;3、外部脚本是将JavaScript代码放置在一个独立的文件;4、外部脚本是将JavaScript代码放置在一个独立的文件。

655

2023.09.12

Js中Symbol类详解
Js中Symbol类详解

javascript中的Symbol数据类型是一种基本数据类型,用于表示独一无二的值。Symbol的特点:1、独一无二,每个Symbol值都是唯一的,不会与其他任何值相等;2、不可变性,Symbol值一旦创建,就不能修改或者重新赋值;3、隐藏性,Symbol值不会被隐式转换为其他类型;4、无法枚举,Symbol值作为对象的属性名时,默认是不可枚举的。

548

2023.09.20

漫蛙2入口地址合集
漫蛙2入口地址合集

本专题整合了漫蛙2入口汇总,阅读专题下面的文章了解更多详细内容。

162

2026.01.06

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Sass 教程
Sass 教程

共14课时 | 0.7万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.8万人学习

CSS教程
CSS教程

共754课时 | 18万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号