Class WebviewWidget

Hierarchy (view full)

BaseWidget
- WebviewWidget
  - CustomEditorWidget

Implements

StatefulWidget
ExtractableWidget
BadgeWidget

Index

Constructors

constructor

Accessors

badge badgeTooltip contentOptions onDidChangeBadge onDidChangeBadgeTooltip state

Constructors

constructor

new WebviewWidget(options?): WebviewWidget
Parameters
- Optional options: IOptions
Returns WebviewWidget
Inherited from BaseWidget.constructor
- Defined in packages/core/lib/browser/widgets/widget.d.ts:59

Properties

`Protected` `Optional` _badge

_badge?: number

`Protected` `Optional` _badgeTooltip

_badgeTooltip?: string

`Protected` _contentOptions

_contentOptions: WebviewContentOptions = {}

`Protected` _state

_state: undefined | string

`Protected` `Readonly` contextKeyService

contextKeyService: ContextKeyService

`Protected` `Readonly` contextMenuRenderer

contextMenuRenderer: ContextMenuRenderer

`Protected` element

element: undefined | HTMLIFrameElement

`Protected` `Readonly` environment

environment: WebviewEnvironment

`Readonly` externalEndpoint

externalEndpoint: string

`Protected` `Readonly` externalUriService

externalUriService: ExternalUriService

`Protected` `Readonly` fileService

fileService: FileService

`Protected` hideTimeout

hideTimeout: any

`Protected` html

html: string = ''

`Protected` iconUrl

iconUrl: undefined | IconUrl

`Readonly` identifier

identifier: WebviewWidgetIdentifier

isExtractable

isExtractable: boolean = true

`Protected` `Readonly` keybindings

keybindings: KeybindingRegistry

`Protected` `Readonly` mouseTracker

mouseTracker: ApplicationShellMouseTracker

`Protected` onDidChangeBadgeEmitter

onDidChangeBadgeEmitter: Emitter<void> = ...

`Protected` onDidChangeBadgeTooltipEmitter

onDidChangeBadgeTooltipEmitter: Emitter<void> = ...

`Readonly` onMessage

onMessage: Event<any> = ...

`Protected` `Readonly` onMessageEmitter

onMessageEmitter: Emitter<any> = ...

`Protected` `Readonly` openerService

openerService: OpenerService

options

options: WebviewPanelOptions = {}

`Protected` `Readonly` outputManager

outputManager: OutputChannelManager

`Protected` `Readonly` pendingMessages

pendingMessages: any[] = []

`Protected` `Readonly` preferences

preferences: WebviewPreferences

`Protected` ready

ready: Deferred<void> = ...

`Protected` `Readonly` resourceCache

resourceCache: WebviewResourceCache

secondaryWindow

secondaryWindow: undefined | Window = undefined

`Protected` `Readonly` sharedStyle

sharedStyle: PluginSharedStyle

`Protected` `Readonly` themeDataProvider

themeDataProvider: WebviewThemeDataProvider

`Protected` `Readonly` toDisposeOnIcon

toDisposeOnIcon: DisposableCollection = ...

`Protected` `Readonly` toHide

toHide: DisposableCollection = ...

`Protected` transparentOverlay

transparentOverlay: HTMLElement

viewState

viewState: WebviewPanelViewState = ...

viewType

viewType: string

`Static` FACTORY_ID

FACTORY_ID: string = 'plugin-webview'

`Static` `Private` `Readonly` standardSupportedLinkSchemes

standardSupportedLinkSchemes: Set<string> = ...

Accessors

badge

get badge(): undefined | number
Returns undefined | number
Implementation of BadgeWidget.badge
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:242
set badge(badge): void
Parameters
- badge: undefined | number
Returns void
Implementation of BadgeWidget.badge
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:246

badgeTooltip

get badgeTooltip(): undefined | string
Returns undefined | string
Implementation of BadgeWidget.badgeTooltip
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:251
set badgeTooltip(badgeTooltip): void
Parameters
- badgeTooltip: undefined | string
Returns void
Implementation of BadgeWidget.badgeTooltip
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:255

contentOptions

get contentOptions(): WebviewContentOptions
Returns WebviewContentOptions
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:177

onDidChangeBadge

get onDidChangeBadge(): Event<void>
Returns Event<void>
Implementation of BadgeWidget.onDidChangeBadge
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:234

onDidChangeBadgeTooltip

get onDidChangeBadgeTooltip(): Event<void>
Returns Event<void>
Implementation of BadgeWidget.onDidChangeBadgeTooltip
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:238

state

get state(): undefined | string
Returns undefined | string
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:182

Methods

`Protected` dispatchMouseEvent

dispatchMouseEvent(type, data): void
Parameters
- type: string
- data: MouseEvent
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:390

`Protected` doHide

doHide(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:286

`Protected` doSend

doSend(channel, data?): Promise<void>
Parameters
- channel: string
- Optional data: any
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:650

`Protected` getRedirect

getRedirect(url): Promise<undefined | string>
Parameters
- url: string
Returns Promise<undefined | string>
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:414

handleContextMenu

handleContextMenu(event): void
Parameters
- event: {
      clientX: number;
      clientY: number;
      context: any;
  }
  - clientX: number
  - clientY: number
  - context: any
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:399

`Protected` init

init(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:207

`Protected` loadLocalhost

loadLocalhost(origin): Promise<void>
Parameters
- origin: string
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:385

`Protected` loadResource

loadResource(requestPath, requestQuery?): Promise<void>
Parameters
- requestPath: string
- requestQuery: string = ''
Returns Promise<void>
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:545

`Protected` normalizeRequestUri

normalizeRequestUri(requestPath): URI
Parameters
- requestPath: string
Returns URI
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:590

`Protected` on

on<T>(channel, handler): Disposable
Type Parameters
- T = unknown
Parameters
- channel: WebviewMessageChannels
- handler: ((data) => void)
  - - (data): void
    - Parameters
      data: T
      Returns void
Returns Disposable
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:673

`Protected` onActivateRequest

onActivateRequest(msg): void
Parameters
- msg: Message
Returns void
Implementation of ExtractableWidget.onActivateRequest
Overrides BaseWidget.onActivateRequest
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:495

`Protected` onAfterAttach

onAfterAttach(msg): void
Parameters
- msg: Message
Returns void
Implementation of ExtractableWidget.onAfterAttach
Overrides BaseWidget.onAfterAttach
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:267

`Protected` onAfterHide

onAfterHide(msg): void
Parameters
- msg: Message
Returns void
Implementation of ExtractableWidget.onAfterHide
Overrides BaseWidget.onAfterHide
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:281

`Protected` onBeforeAttach

onBeforeAttach(msg): void
Parameters
- msg: Message
Returns void
Implementation of ExtractableWidget.onBeforeAttach
Overrides BaseWidget.onBeforeAttach
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:260

`Protected` onBeforeShow

onBeforeShow(msg): void
Parameters
- msg: Message
Returns void
Implementation of ExtractableWidget.onBeforeShow
Overrides BaseWidget.onBeforeShow
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:276

`Protected` openLink

openLink(link): void
Parameters
- link: URI
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:518

`Protected` postMessage

postMessage(channel, data?): void
Parameters
- channel: string
- Optional data: any
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:662

`Protected` preprocessHtml

preprocessHtml(value): string
Parameters
- value: string
Returns string
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:485

reload

reload(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:500

restoreState

restoreState(oldState): void
Parameters
- oldState: plugin-ext.State
Returns void
Implementation of StatefulWidget.restoreState
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:634

sendMessage

sendMessage(data): void
Parameters
- data: any
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:607

setContentOptions

setContentOptions(contentOptions): void
Parameters
- contentOptions: WebviewContentOptions
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:445

setHTML

setHTML(value): void
Parameters
- value: string
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:480

setIconUrl

setIconUrl(iconUrl): void
Parameters
- iconUrl: undefined | IconUrl
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:455

setIframeHeight

setIframeHeight(height): void
Parameters
- height: number
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:644

storeState

storeState(): plugin-ext.State
Returns plugin-ext.State
Implementation of StatefulWidget.storeState
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:623

`Protected` style

style(): void
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:513

`Protected` toEndpoint

toEndpoint(pathname): string
Parameters
- pathname: string
Returns string
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:476

`Protected` toRemoteUrl

toRemoteUrl(localUri): Promise<string>
Parameters
- localUri: URI
Returns Promise<string>
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:436

`Protected` toSupportedLink

toSupportedLink(link): undefined | URI
Parameters
- link: URI
Returns undefined | URI
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:525

`Protected` trace

trace(kind, channel, data?): void
Parameters
- kind: "in" | "out"
- channel: string
- Optional data: any
Returns void
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:689

Class WebviewWidget

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns WebviewWidget

Properties

Protected Optional _badge

Protected Optional _badgeTooltip

Protected _contentOptions

Protected _state

Protected Readonly contextKeyService

Protected Readonly contextMenuRenderer

Protected element

Protected Readonly environment

Readonly externalEndpoint

Protected Readonly externalUriService

Protected Readonly fileService

Protected hideTimeout

Protected html

Protected iconUrl

Readonly identifier

isExtractable

Protected Readonly keybindings

Protected Readonly mouseTracker

Protected onDidChangeBadgeEmitter

Protected onDidChangeBadgeTooltipEmitter

Readonly onMessage

Protected Readonly onMessageEmitter

Protected Readonly openerService

options

Protected Readonly outputManager

Protected Readonly pendingMessages

Protected Readonly preferences

Protected ready

Protected Readonly resourceCache

secondaryWindow

Protected Readonly sharedStyle

Protected Readonly themeDataProvider

Protected Readonly toDisposeOnIcon

Protected Readonly toHide

Protected transparentOverlay

viewState

viewType

Static FACTORY_ID

Static Private Readonly standardSupportedLinkSchemes

Accessors

badge

Returns undefined | number

Parameters

Returns void

badgeTooltip

Returns undefined | string

Parameters

Returns void

contentOptions

Returns WebviewContentOptions

onDidChangeBadge

Returns Event<void>

onDidChangeBadgeTooltip

Returns Event<void>

state

Returns undefined | string

Methods

Protected dispatchMouseEvent

Parameters

Returns void

Protected doHide

Returns void

Protected doSend

Parameters

Returns Promise<void>

Protected doShow

Returns void

`Protected` `Optional` _badge

`Protected` `Optional` _badgeTooltip

`Protected` _contentOptions

`Protected` _state

`Protected` `Readonly` contextKeyService

`Protected` `Readonly` contextMenuRenderer

`Protected` element

`Protected` `Readonly` environment

`Readonly` externalEndpoint

`Protected` `Readonly` externalUriService

`Protected` `Readonly` fileService

`Protected` hideTimeout

`Protected` html

`Protected` iconUrl

`Readonly` identifier

`Protected` `Readonly` keybindings

`Protected` `Readonly` mouseTracker

`Protected` onDidChangeBadgeEmitter

`Protected` onDidChangeBadgeTooltipEmitter

`Readonly` onMessage

`Protected` `Readonly` onMessageEmitter

`Protected` `Readonly` openerService

`Protected` `Readonly` outputManager

`Protected` `Readonly` pendingMessages

`Protected` `Readonly` preferences

`Protected` ready

`Protected` `Readonly` resourceCache

`Protected` `Readonly` sharedStyle

`Protected` `Readonly` themeDataProvider

`Protected` `Readonly` toDisposeOnIcon

`Protected` `Readonly` toHide

`Protected` transparentOverlay

`Static` FACTORY_ID

`Static` `Private` `Readonly` standardSupportedLinkSchemes

`Protected` dispatchMouseEvent

`Protected` doHide

`Protected` doSend

`Protected` doShow

`Protected` doUpdateContent

`Protected` forceHide

`Protected` forwardConsoleLog

`Protected` getRedirect

`Protected` init

`Protected` loadLocalhost

`Protected` loadResource

`Protected` normalizeRequestUri

`Protected` on

`Protected` onActivateRequest

`Protected` onAfterAttach

`Protected` onAfterHide

`Protected` onBeforeAttach

`Protected` onBeforeShow

`Protected` openLink

`Protected` postMessage

`Protected` preprocessHtml