dots.vscode.webview-panel

Liking cljdoc? Tell your friends :D

ClojureScript only.

active?
dispose
icon-path
on-did-change-view-state
on-did-dispose
options
reveal
set-icon-path!
set-title!
title
view-column
view-type
visible?
webview

A panel that contains a webview.

A panel that contains a webview.

raw docstring

active?^cljs

(active? webview-panel)

Whether the panel is active (focused by the user).

Returns: boolean

Whether the panel is active (focused by the user).

**Returns:** `boolean`

source raw docstring

dispose^cljs

(dispose webview-panel)

Dispose of the webview panel.

This closes the panel if it showing and disposes of the resources owned by the webview. Webview panels are also disposed when the user closes the webview panel. Both cases fire the onDispose event.

Returns: any

Dispose of the webview panel.

This closes the panel if it showing and disposes of the resources owned by the webview.
Webview panels are also disposed when the user closes the webview panel. Both cases
fire the `onDispose` event.

**Returns:** `any`

source raw docstring

icon-path^cljs

(icon-path webview-panel)

Icon for the panel shown in UI.

Returns: Uri | { readonly light: Uri; readonly dark: Uri; } | undefined

Icon for the panel shown in UI.

**Returns:** `Uri | { readonly light: Uri; readonly dark: Uri; } | undefined`

source raw docstring

on-did-change-view-state^cljs

(on-did-change-view-state webview-panel)

(on-did-change-view-state webview-panel listener)

(on-did-change-view-state webview-panel listener this-args)

(on-did-change-view-state webview-panel listener this-args disposables)

Fired when the panel's view state changes.

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

Fired when the panel's view state changes.

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

on-did-dispose^cljs

(on-did-dispose webview-panel)

(on-did-dispose webview-panel listener)

(on-did-dispose webview-panel listener this-args)

(on-did-dispose webview-panel listener this-args disposables)

Fired when the panel is disposed.

This may be because the user closed the panel or because .dispose() was called on it.

Trying to use the panel after it has been disposed throws an exception.

Parameters:

listener: (e: T) => any - The listener function will be called when the event happens.
this-args: any - The this-argument which will be used when calling the event listener.
disposables: Disposable[] | undefined - An array to which a {@link Disposable } will be added.

Returns: Disposable - A disposable which unsubscribes the event listener.

Fired when the panel is disposed.

This may be because the user closed the panel or because `.dispose()` was
called on it.

Trying to use the panel after it has been disposed throws an exception.

**Parameters:**
- `listener`: `(e: T) => any` - The listener function will be called when the event happens.
- `this-args`: `any` - The `this`-argument which will be used when calling the event listener.
- `disposables`: `Disposable[] | undefined` - An array to which a {@link Disposable } will be added.

**Returns:** `Disposable` - A disposable which unsubscribes the event listener.

source raw docstring

options^cljs

(options webview-panel)

Content settings for the webview panel.

Returns: WebviewPanelOptions

Content settings for the webview panel.

**Returns:** `WebviewPanelOptions`

source raw docstring

reveal^cljs

(reveal webview-panel)

(reveal webview-panel view-column)

(reveal webview-panel view-column preserve-focus?)

Show the webview panel in a given column.

A webview panel may only show in a single column at a time. If it is already showing, this method moves it to a new column.

Parameters:

view-column: ViewColumn | undefined - View column to show the panel in. Shows in the current viewColumn if undefined.
preserve-focus?: boolean | undefined - When true, the webview will not take focus.

Returns: void

Show the webview panel in a given column.

A webview panel may only show in a single column at a time. If it is already showing, this
method moves it to a new column.

**Parameters:**
- `view-column`: `ViewColumn | undefined` - View column to show the panel in. Shows in the current `viewColumn` if undefined.
- `preserve-focus?`: `boolean | undefined` - When `true`, the webview will not take focus.

**Returns:** `void`

source raw docstring

set-icon-path!^cljs

(set-icon-path! webview-panel value)

Icon for the panel shown in UI.

Icon for the panel shown in UI.

source raw docstring

set-title!^cljs

(set-title! webview-panel value)

Title of the panel shown in UI.

Title of the panel shown in UI.

source raw docstring

title^cljs

(title webview-panel)

Title of the panel shown in UI.

Returns: string

Title of the panel shown in UI.

**Returns:** `string`

source raw docstring

view-column^cljs

(view-column webview-panel)

Editor position of the panel. This property is only set if the webview is in one of the editor view columns.

Returns: ViewColumn | undefined

Editor position of the panel. This property is only set if the webview is in
one of the editor view columns.

**Returns:** `ViewColumn | undefined`

source raw docstring

view-type^cljs

(view-type webview-panel)

Identifies the type of the webview panel, such as 'markdown.preview'.

Returns: string

Identifies the type of the webview panel, such as `'markdown.preview'`.

**Returns:** `string`

source raw docstring

visible?^cljs

(visible? webview-panel)

Whether the panel is visible.

Returns: boolean

Whether the panel is visible.

**Returns:** `boolean`

source raw docstring

webview^cljs

(webview webview-panel)

{@linkcode Webview } belonging to the panel.

Returns: Webview

{@linkcode Webview } belonging to the panel.

**Returns:** `Webview`

source raw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

Keyboard shortcuts Report a problem cljdoc on GitHub

× close