WebviewWidget | Theia TypeDoc

Hierarchy

BaseWidget
- WebviewWidget
  - CustomEditorWidget

Implements

StatefulWidget

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new WebviewWidget(options?: IOptions): WebviewWidget

Inherited from BaseWidget.constructor
- Defined in node_modules/@phosphor/widgets/lib/widget.d.ts:15
Construct a new widget.

Parameters
- Optional options: IOptions
  
  The options for initializing the widget.
Returns WebviewWidget

Properties

Protected _contentOptions

_contentOptions: WebviewContentOptions = {}

Protected _state

_state: undefined | string

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 | string | { dark: string; light: string }

Readonly identifier

identifier: WebviewWidgetIdentifier

Protected Readonly keybindings

keybindings: KeybindingRegistry

Protected Readonly mouseTracker

mouseTracker: ApplicationShellMouseTracker

Readonly onDidChangeVisibility

onDidChangeVisibility: Event<boolean>

Protected Readonly onDidChangeVisibilityEmitter

onDidChangeVisibilityEmitter: Emitter<boolean>

Readonly onDidDispose

onDidDispose: Event<void>

Protected Readonly onDidDisposeEmitter

onDidDisposeEmitter: Emitter<void>

Readonly onMessage

onMessage: Event<any> = ...

Protected Readonly onMessageEmitter

onMessageEmitter: Emitter<any> = ...

Readonly onScrollUp

onScrollUp: Event<void>

Protected Readonly onScrollUpEmitter

onScrollUpEmitter: Emitter<void>

Readonly onScrollYReachEnd

onScrollYReachEnd: Event<void>

Protected Readonly onScrollYReachEndEmitter

onScrollYReachEndEmitter: Emitter<void>

Protected Readonly openerService

openerService: OpenerService

options

options: WebviewPanelOptions = {}

Protected Readonly outputManager

outputManager: OutputChannelManager

Protected Readonly pendingMessages

pendingMessages: any[] = []

Protected Readonly preferences

preferences: PreferenceProxy<WebviewConfiguration>

Protected ready

ready: Deferred<void> = ...

Protected Readonly resourceCache

resourceCache: WebviewResourceCache

Protected Optional scrollBar

scrollBar: PerfectScrollbar

Protected Optional scrollOptions

scrollOptions: Options

Protected Readonly sharedStyle

sharedStyle: PluginSharedStyle

Protected Readonly themeDataProvider

themeDataProvider: WebviewThemeDataProvider

Protected Readonly toDispose

toDispose: DisposableCollection

Protected Readonly toDisposeOnDetach

toDisposeOnDetach: DisposableCollection

Protected Readonly toDisposeOnIcon

toDisposeOnIcon: DisposableCollection = ...

Protected Readonly toHide

toHide: DisposableCollection = ...

Protected transparentOverlay

transparentOverlay: HTMLElement

viewColumn

viewColumn: ViewColumn

viewState

viewState: WebviewPanelViewState = ...

viewType

viewType: string

Static FACTORY_ID

FACTORY_ID: string = 'plugin-webview'

Static Private Readonly standardSupportedLinkSchemes

standardSupportedLinkSchemes: Set<string> = ...

Accessors

contentOptions

get contentOptions(): WebviewContentOptions

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:153
Returns WebviewContentOptions

state

get state(): undefined | string

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:158
Returns undefined | string

Methods

Protected addClipboardListener

addClipboardListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>): void

Inherited from BaseWidget.addClipboardListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:83
Type parameters
- K: "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
Returns void

Protected addEventListener

addEventListener<K>(element: HTMLElement, type: K, listener: EventListenerOrEventListenerObject<K>, useCapture?: boolean): void

Inherited from BaseWidget.addEventListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:81
Type parameters
- K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- listener: EventListenerOrEventListenerObject<K>
- Optional useCapture: boolean
Returns void

Protected addKeyListener

addKeyListener<K>(element: HTMLElement, keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[], action: (event: KeyboardEvent) => boolean | void | Object, ...additionalEventTypes: K[]): void

Inherited from BaseWidget.addKeyListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:82
Type parameters
- K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- keysOrKeyCodes: Predicate | Key | KeyCode | (Key | KeyCode)[]
- action: (event: KeyboardEvent) => boolean | void | Object
  - - (event: KeyboardEvent): boolean | void | Object
    - Parameters
      - event: KeyboardEvent
      Returns boolean | void | Object
- Rest ...additionalEventTypes: K[]
Returns void

Protected addUpdateListener

addUpdateListener<K>(element: HTMLElement, type: K, useCapture?: boolean): void

Inherited from BaseWidget.addUpdateListener
- Defined in packages/core/lib/browser/widgets/widget.d.ts:80
Type parameters
- K: "fullscreenchange" | "fullscreenerror" | "abort" | "animationcancel" | "animationend" | "animationiteration" | "animationstart" | "auxclick" | "blur" | "cancel" | "canplay" | "canplaythrough" | "change" | "click" | "close" | "contextmenu" | "cuechange" | "dblclick" | "drag" | "dragend" | "dragenter" | "dragexit" | "dragleave" | "dragover" | "dragstart" | "drop" | "durationchange" | "emptied" | "ended" | "error" | "focus" | "focusin" | "focusout" | "gotpointercapture" | "input" | "invalid" | "keydown" | "keypress" | "keyup" | "load" | "loadeddata" | "loadedmetadata" | "loadstart" | "lostpointercapture" | "mousedown" | "mouseenter" | "mouseleave" | "mousemove" | "mouseout" | "mouseover" | "mouseup" | "pause" | "play" | "playing" | "pointercancel" | "pointerdown" | "pointerenter" | "pointerleave" | "pointermove" | "pointerout" | "pointerover" | "pointerup" | "progress" | "ratechange" | "reset" | "resize" | "scroll" | "securitypolicyviolation" | "seeked" | "seeking" | "select" | "selectionchange" | "selectstart" | "stalled" | "submit" | "suspend" | "timeupdate" | "toggle" | "touchcancel" | "touchend" | "touchmove" | "touchstart" | "transitioncancel" | "transitionend" | "transitionrun" | "transitionstart" | "volumechange" | "waiting" | "wheel" | "copy" | "cut" | "paste"
Parameters
- element: HTMLElement
- type: K
- Optional useCapture: boolean
Returns void

clearFlag

clearFlag(flag: Flag): void

Inherited from BaseWidget.clearFlag
- Defined in packages/core/lib/browser/widgets/widget.d.ts:85
Parameters
- flag: Flag
Returns void

Protected disableScrollBarFocus

disableScrollBarFocus(scrollContainer: HTMLElement): void

Inherited from BaseWidget.disableScrollBarFocus
- Defined in packages/core/lib/browser/widgets/widget.d.ts:78
Parameters
- scrollContainer: HTMLElement
Returns void

Protected dispatchMouseEvent

dispatchMouseEvent(type: string, data: MouseEvent): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:323
Parameters
- type: string
- data: MouseEvent
Returns void

dispose

dispose(): void

Inherited from BaseWidget.dispose
- Defined in packages/core/lib/browser/widgets/widget.d.ts:71
Returns void

Protected doHide

doHide(): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:227
Returns void

Protected doSend

doSend(channel: string, data?: any): Promise<void>

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:548
Parameters
- channel: string
- Optional data: any
Returns Promise<void>

Protected doShow

doShow(): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:242
Returns void

Protected doUpdateContent

doUpdateContent(): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:519
Returns void

Protected forceHide

forceHide(): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:236
Returns void

Protected getRedirect

getRedirect(url: string): Promise<undefined | string>

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

Protected getScrollContainer

getScrollContainer(): MaybePromise<HTMLElement>

Inherited from BaseWidget.getScrollContainer
- Defined in packages/core/lib/browser/widgets/widget.d.ts:77
Returns MaybePromise<HTMLElement>

Protected init

init(): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:176
Returns void

Protected loadLocalhost

loadLocalhost(origin: string): Promise<void>

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

Protected loadResource

loadResource(requestPath: string): Promise<void>

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:450
Parameters
- requestPath: string
Returns Promise<void>

Protected normalizeRequestUri

normalizeRequestUri(requestPath: string): default

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:494
Parameters
- requestPath: string
Returns default

Protected on

on<T>(channel: WebviewMessageChannels, handler: (data: T) => void): Disposable

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

Protected onActivateRequest

onActivateRequest(msg: Message): void

Overrides BaseWidget.onActivateRequest
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:413
Parameters
- msg: Message
Returns void

Protected onAfterAttach

onAfterAttach(msg: Message): void

Overrides BaseWidget.onAfterAttach
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:208
Parameters
- msg: Message
Returns void

Protected onAfterDetach

onAfterDetach(msg: Message): void

Inherited from BaseWidget.onAfterDetach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:74
Parameters
- msg: Message
Returns void

Protected onAfterHide

onAfterHide(msg: Message): void

Overrides BaseWidget.onAfterHide
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:222
Parameters
- msg: Message
Returns void

Protected onBeforeAttach

onBeforeAttach(msg: Message): void

Overrides BaseWidget.onBeforeAttach
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:201
Parameters
- msg: Message
Returns void

Protected onBeforeDetach

onBeforeDetach(msg: Message): void

Inherited from BaseWidget.onBeforeDetach
- Defined in packages/core/lib/browser/widgets/widget.d.ts:75
Parameters
- msg: Message
Returns void

Protected onBeforeShow

onBeforeShow(msg: Message): void

Overrides BaseWidget.onBeforeShow
- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:217
Parameters
- msg: Message
Returns void

Protected onCloseRequest

onCloseRequest(msg: Message): void

Inherited from BaseWidget.onCloseRequest
- Defined in packages/core/lib/browser/widgets/widget.d.ts:72
Parameters
- msg: Message
Returns void

Protected onUpdateRequest

onUpdateRequest(msg: Message): void

Inherited from BaseWidget.onUpdateRequest
- Defined in packages/core/lib/browser/widgets/widget.d.ts:79
Parameters
- msg: Message
Returns void

Protected openLink

openLink(link: default): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:427
Parameters
- link: default
Returns void

Protected postMessage

postMessage(channel: string, data?: any): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:560
Parameters
- channel: string
- Optional data: any
Returns void

Protected preprocessHtml

preprocessHtml(value: string): string

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:403
Parameters
- value: string
Returns string

reload

reload(): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:418
Returns void

restoreState

restoreState(oldState: State): void

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

sendMessage

sendMessage(data: any): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:511
Parameters
- data: any
Returns void

setContentOptions

setContentOptions(contentOptions: WebviewContentOptions): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:363
Parameters
- contentOptions: WebviewContentOptions
Returns void

setFlag

setFlag(flag: Flag): void

Inherited from BaseWidget.setFlag
- Defined in packages/core/lib/browser/widgets/widget.d.ts:84
Parameters
- flag: Flag
Returns void

setHTML

setHTML(value: string): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:398
Parameters
- value: string
Returns void

setIconUrl

setIconUrl(iconUrl: undefined | string | { dark: string; light: string }): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:373
Parameters
- iconUrl: undefined | string | { dark: string; light: string }
Returns void

storeState

storeState(): State

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

Protected style

style(): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:422
Returns void

Protected toEndpoint

toEndpoint(pathname: string): string

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:394
Parameters
- pathname: string
Returns string

Protected toRemoteUrl

toRemoteUrl(localUri: default): Promise<string>

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:354
Parameters
- localUri: default
Returns Promise<string>

Protected toSupportedLink

toSupportedLink(link: default): undefined | default

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:434
Parameters
- link: default
Returns undefined | default

Protected trace

trace(kind: "in" | "out", channel: string, data?: any): void

- Defined in packages/plugin-ext/src/main/browser/webview/webview.ts:583
Parameters
- kind: "in" | "out"
- channel: string
- Optional data: any
Returns void

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional options: IOptions

Returns WebviewWidget

Properties

Protected _contentOptions

Protected _state

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

Readonly onDidChangeVisibility

Protected Readonly onDidChangeVisibilityEmitter

Readonly onDidDispose

Protected Readonly onDidDisposeEmitter

Readonly onMessage

Protected Readonly onMessageEmitter

Readonly onScrollUp

Protected Readonly onScrollUpEmitter

Readonly onScrollYReachEnd

Protected Readonly onScrollYReachEndEmitter

Protected Readonly openerService

options

Protected Readonly outputManager

Protected Readonly pendingMessages

Protected Readonly preferences

Protected ready

Protected Readonly resourceCache

Protected Optional scrollBar

Protected Optional scrollOptions

Protected Readonly sharedStyle

Protected Readonly themeDataProvider

Protected Readonly toDispose

Protected Readonly toDisposeOnDetach

Protected Readonly toDisposeOnIcon

Protected Readonly toHide

Protected transparentOverlay

viewColumn

viewState

viewType

Static FACTORY_ID

Static Private Readonly standardSupportedLinkSchemes

Accessors

contentOptions

Returns WebviewContentOptions

state

Returns undefined | string

Methods

Protected addClipboardListener

Type parameters

K: "copy" | "cut" | "paste"

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Returns void

Protected addEventListener

Type parameters

Parameters

element: HTMLElement

type: K

listener: EventListenerOrEventListenerObject<K>

Optional useCapture: boolean

Returns void

Protected addKeyListener