跳转到主内容

界面:Webview

定义于: packages/extension-api/src/extension-api.d.ts:1983

显示 HTML 内容,类似于 iframe。

属性

cspSource

readonly cspSource: string

定义于: packages/extension-api/src/extension-api.d.ts:2018

Webview 资源的 Content Security Policy 源。


html

html: string

定义于: packages/extension-api/src/extension-api.d.ts:1995

Webview 的 HTML 内容。

这应该是一个完整、有效的 HTML 文档。更改此属性会导致 Webview 重新加载。


onDidReceiveMessage

readonly onDidReceiveMessage: Event<unknown>

定义于: packages/extension-api/src/extension-api.d.ts:2002

当 Webview 内容发送消息时触发。

Webview 内容可以将字符串或 JSON 可序列化对象发送回扩展。


options

options: WebviewOptions

定义于: packages/extension-api/src/extension-api.d.ts:1987

Webview 的内容设置。

方法

asWebviewUri()

asWebviewUri(localResource): Uri

定义于: packages/extension-api/src/extension-api.d.ts:2012

将本地文件系统的 URI 转换为可在 Webview 中使用的 URI。

参数

localResource

Uri

返回

Uri


postMessage()

postMessage(message): Promise<boolean>

定义于: packages/extension-api/src/extension-api.d.ts:2007

向 Webview 内容发送消息。

参数

message

unknown

返回值

Promise<boolean>