0

0

VSCode的Webview API:在编辑器中创建丰富的UI界面

P粉986688829

P粉986688829

发布时间:2026-01-08 16:36:02

|

500人浏览过

|

来源于php中文网

原创

VSCode扩展可通过Webview API嵌入交互式HTML界面:一、用createWebviewPanel创建独立可拖拽面板,配置CSP与消息通信;二、用registerWebviewViewProvider将Webview嵌入侧边栏,声明views并管理状态;三、通过asWebviewUri安全加载本地资源并隔离样式。

vscode的webview api:在编辑器中创建丰富的ui界面

如果您在开发VSCode扩展时希望在编辑器内部嵌入自定义的、具备交互能力的HTML界面,则Webview API提供了直接集成网页内容的能力。以下是实现该功能的关键方法:

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

一、使用webview.panel创建独立面板

该方式通过vscode.window.createWebviewPanel启动一个可折叠、可拖拽的独立面板,适合承载中等复杂度的UI,支持状态持久化与消息通信。

1、在extension.ts中调用vscode.window.createWebviewPanel,传入视图类型、标题、显示位置及选项对象。

2、设置webview.options以启用脚本执行,并配置本地资源根路径为vscode-webview-resource。

3、通过webview.html属性注入完整HTML字符串,其中script标签需使用nonce属性并配合CSP策略。

4、监听webview.onDidReceiveMessage事件处理前端发来的消息,并使用webview.postMessage向前端发送响应数据。

二、嵌入内联webview.view到侧边栏或编辑器区域

该方式利用vscode.window.registerWebviewViewProvider注册视图提供者,使Webview作为原生UI组件出现在侧边栏、大纲或自定义视图容器中,适配VSCode原生布局系统。

1、定义类实现WebviewViewProvider接口,在resolveWebviewView方法中配置webview属性与初始HTML。

迅易鲜花网店管理系统
迅易鲜花网店管理系统

功能模块:功能完善、展示信息丰富的电子商店销售平台;针对企业与个人的网上销售系统;开放式远程商店管理;完善的订单管理 ; 快速建店:只需简单设置,10分钟即可以建立一个功能完备的网上商城; 操作简便:采用人性化的布局,界面规范,操作简捷; 安装方便:只需传到您的虚拟空间即可; HTML编辑器:内置优秀的HTML在线编辑器; 可扩展性:软件构架灵活,考虑未来功能扩充之需要,具有较强的可扩展性; 完善

下载

2、在package.json的contributes.views部分声明webview.view条目,指定id、name和icon。

3、确保webview.cspSource与HTML中的Content-Security-Policy meta标签值一致,例如vscode-webview://$(webview-csp-source)。

4、使用vscode.getState()和vscode.setState()在Webview生命周期中保存和恢复UI状态。

三、加载本地静态资源并启用样式隔离

为避免CSS污染VSCode主界面或被其样式覆盖,需将JS/CSS文件作为base64内联或通过vscode-resource协议加载,并启用webview的enableScripts和localResourceRoots选项。

1、将CSS文件读取为字符串,使用vscode.Uri.file()转换为vscode-resource URI格式。

2、在HTML中通过标签引用该URI,确保href属性值形如vscode-resource:/Users/xxx/extension/media/style.css

3、调用webview.asWebviewUri()方法对任意本地路径进行安全转换,此步骤不可省略,否则资源加载将被CSP拦截

4、在HTML的style标签内添加:root { --vscode-editor-background: #1e1e1e; }等变量映射,复用VSCode主题色。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

406

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

531

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

309

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

74

2025.09.10

css
css

css是层叠样式表,用来表现HTML或XML等文件样式的计算机语言,不仅可以静态地修饰网页,还可以配合各种脚本语言动态地对网页各元素进行格式化。php中文网还为大家带来html的相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

509

2023.06.15

css居中
css居中

css居中:1、通过“margin: 0 auto; text-align: center”实现水平居中;2、通过“display:flex”实现水平居中;3、通过“display:table-cell”和“margin-left”实现居中。本专题为大家提供css居中的相关的文章、下载、课程内容,供大家免费下载体验。

262

2023.07.27

css如何插入图片
css如何插入图片

cssCSS是层叠样式表(Cascading Style Sheets)的缩写。它是一种用于描述网页或应用程序外观和样式的标记语言。CSS可以控制网页的字体、颜色、布局、大小、背景、边框等方面,使得网页的外观更加美观和易于阅读。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

745

2023.07.28

css超出显示...
css超出显示...

在CSS中,当文本内容超出容器的宽度或高度时,可以使用省略号来表示被隐藏的文本内容。本专题为大家提供css超出显示...的相关文章,相关教程,供大家免费体验。

536

2023.08.01

Golang 分布式缓存与高可用架构
Golang 分布式缓存与高可用架构

本专题系统讲解 Golang 在分布式缓存与高可用系统中的应用,涵盖缓存设计原理、Redis/Etcd集成、数据一致性与过期策略、分布式锁、缓存穿透/雪崩/击穿解决方案,以及高可用架构设计。通过实战案例,帮助开发者掌握 如何使用 Go 构建稳定、高性能的分布式缓存系统,提升大型系统的响应速度与可靠性。

59

2026.01.09

热门下载

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

精品课程

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

共14课时 | 0.7万人学习

Bootstrap 5教程
Bootstrap 5教程

共46课时 | 2.8万人学习

CSS教程
CSS教程

共754课时 | 18.3万人学习

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

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