@kkdev92/vscode-ext-kit - v4.1.1
    Preparing search index...

    Interface ManagedWebviewPanel<S>

    A managed webview living in its own editor tab.

    interface ManagedWebviewPanel<S extends WebviewRpcSchema = WebviewRpcSchema> {
        cspSource: string;
        rpc: WebviewRpc<S>;
        asWebviewUri(extensionRelativePath: string): string;
        dispose(): void;
        onDidChangeVisibility(
            listener: (visible: boolean) => void,
        ): PlatformRegistration;
        onDidDispose(listener: () => void): PlatformRegistration;
        onMessage(listener: (message: unknown) => void): PlatformRegistration;
        post(message: unknown): Promise<boolean>;
        reveal(column?: number): void;
        setHtml(html: string): void;
        setHtmlFromTemplate(
            templatePath: string,
            variables?: Readonly<Record<string, string>>,
        ): Promise<void>;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index
    cspSource rpc
    asWebviewUri dispose onDidChangeVisibility onDidDispose onMessage post reveal setHtml setHtmlFromTemplate
    cspSource: string

    The source a content security policy has to allow.

    rpc: WebviewRpc<S>

    Typed request/response and events over the raw message channel. Types do not perform runtime payload validation at the webview boundary.

    post

    • 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>

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

    Settings
    Member Visibility

    On This Page
    Properties
    Methods