Interface WebviewService

openPanel

• openPanel<S extends WebviewRpcSchema = WebviewRpcSchema>(
      request: WebviewPanelRequest,
  ): ManagedWebviewPanel<S>

  Opens a panel.

  The application owns it: a panel still open when the extension stops is closed with everything else, so nothing is parked on context.subscriptions and nothing outlives the host.

  Type Parameters

  • S extends WebviewRpcSchema = WebviewRpcSchema

  Parameters

  • request: WebviewPanelRequest

  Returns ManagedWebviewPanel<S>

  Example

  module.commands.handle(OpenPreview, {
    inject: { webviews: Webviews },
    execute: async (_context, _args, { webviews }) => {
      const panel = webviews.openPanel({ viewType: 'sample.preview', title: 'Preview' });
      await panel.setHtmlFromTemplate('media/preview.html');
    },
  });
  Copy