Skip to main content

Interface: Webview

Displays html content, similarly to an iframe.

Properties

cspSource

readonly cspSource: string

Content security policy source for webview resources.

Source

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


html

html: string

HTML contents of the webview.

This should be a complete, valid html document. Changing this property causes the webview to be reloaded.

Source

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


onDidReceiveMessage

readonly onDidReceiveMessage: Event< unknown >

Fired when the webview content posts a message.

Webview content can post strings or json serializable objects back to an extension.

Source

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


options

options: WebviewOptions

Content settings for the webview.

Source

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

Methods

asWebviewUri()

asWebviewUri(localResource): Uri

Convert a uri for the local file system to one that can be used inside webviews.

Parameters

localResource: Uri

Returns

Uri

Source

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


postMessage()

postMessage(message): Promise< boolean >

Post a message to the webview content.

Parameters

message: unknown

Returns

Promise< boolean >

Source

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