跳到主要内容

接口: Webview

显示 html 内容,类似于 iframe。

属性

cspSource

readonly cspSource: string

Webview 资源的内容安全策略源。

定义在

packages/extension-api/src/extension-api.d.ts:1959


html

html: string

Webview 的 HTML 内容。

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

定义在

packages/extension-api/src/extension-api.d.ts:1936


onDidReceiveMessage

readonly onDidReceiveMessage: Event<unknown>

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

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

定义在

packages/extension-api/src/extension-api.d.ts:1943


options

options: WebviewOptions

Webview 的内容设置。

定义在

packages/extension-api/src/extension-api.d.ts:1928

方法

asWebviewUri()

asWebviewUri(localResource): Uri

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

参数

localResource: Uri

返回值

Uri

定义在

packages/extension-api/src/extension-api.d.ts:1953


postMessage()

postMessage(message): Promise<boolean>

向 Webview 内容发布消息。

参数

message: unknown

返回值

Promise<boolean>

定义在

packages/extension-api/src/extension-api.d.ts:1948