Interface ManagedWebview<S>

ReadonlycspSource

Readonlyrpc

asWebviewUri

• asWebviewUri(extensionRelativePath: string): string

  Rewrites an extension-relative path into a uri the content may load.

  Parameters

  • extensionRelativePath: string

  Returns string

onMessage

• onMessage(listener: (message: unknown) => void): PlatformRegistration

  Subscribes to raw, untrusted messages from the page. The caller owns the returned registration. For request/response, prefer ManagedWebview.rpc.

  Parameters

  • listener: (message: unknown) => void

  Returns PlatformRegistration

post

• post(message: unknown): Promise<boolean>

  Sends a raw message accepted by the platform's webview serialization boundary. For request/response, use ManagedWebview.rpc. Resolves false when the platform reports that the content is no longer live.

  Parameters

  • message: unknown

  Returns Promise<boolean>

setHtml

• setHtml(html: string): void

  Replaces the rendered HTML. The caller owns the complete document and its CSP; this method performs no sanitization.

  Parameters

  • html: string

  Returns void

setHtmlFromTemplate

• setHtmlFromTemplate(
      templatePath: string,
      variables?: Readonly<Record<string, string>>,
  ): Promise<void>

  Renders a template file shipped with the extension.

  Placeholders:

  • {{name}} — the value, HTML-escaped
  • {{raw:name}} — the value verbatim, which is an injection vector unless you produced the value yourself
  • {{webviewUri:media/app.js}} — a uri the content may actually load

  Parameters

  • templatePath: string
  • Optionalvariables: Readonly<Record<string, string>>

  Returns Promise<void>

  Example

  await panel.setHtmlFromTemplate('media/editor.html', {
    title: 'Editor',
    cspSource: panel.cspSource,
  });
  Copy