Liking cljdoc? Tell your friends :D

dots.vscode.webview-view

A webview based view.

A webview based view.
raw docstring

badgecljs

(badge webview-view)

The badge to display for this webview view. To remove the badge, set to undefined.

The badge to display for this webview view.
To remove the badge, set to undefined.
sourceraw docstring

descriptioncljs

(description webview-view)

Human-readable string which is rendered less prominently in the title.

Human-readable string which is rendered less prominently in the title.
sourceraw docstring

on-did-change-visibilitycljs

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

Event fired when the visibility of the view changes.

Actions that trigger a visibility change:

  • The view is collapsed or expanded.
  • The user switches to a different view group in the sidebar or panel.

Note that hiding a view using the context menu instead disposes of the view and fires onDidDispose.

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.

Event fired when the visibility of the view changes.

Actions that trigger a visibility change:

- The view is collapsed or expanded.
- The user switches to a different view group in the sidebar or panel.

Note that hiding a view using the context menu instead disposes of the view and fires `onDidDispose`.

**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.
sourceraw docstring

on-did-disposecljs

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

Event fired when the view is disposed.

Views are disposed when they are explicitly hidden by a user (this happens when a user right clicks in a view and unchecks the webview view).

Trying to use the view 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.

Event fired when the view is disposed.

Views are disposed when they are explicitly hidden by a user (this happens when a user
right clicks in a view and unchecks the webview view).

Trying to use the view 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.
sourceraw docstring

set-badge!cljs

(set-badge! webview-view value)

The badge to display for this webview view. To remove the badge, set to undefined.

The badge to display for this webview view.
To remove the badge, set to undefined.
sourceraw docstring

set-description!cljs

(set-description! webview-view value)

Human-readable string which is rendered less prominently in the title.

Human-readable string which is rendered less prominently in the title.
sourceraw docstring

set-title!cljs

(set-title! webview-view value)

View title displayed in the UI.

The view title is initially taken from the extension package.json contribution.

View title displayed in the UI.

The view title is initially taken from the extension `package.json` contribution.
sourceraw docstring

showcljs

(show webview-view)
(show webview-view preserve-focus?)

Reveal the view in the UI.

If the view is collapsed, this will expand it.

Parameters:

  • preserve-focus?: boolean | undefined - When true the view will not take focus.

Returns: void

Reveal the view in the UI.

If the view is collapsed, this will expand it.

**Parameters:**
- `preserve-focus?`: `boolean | undefined` - When `true` the view will not take focus.

**Returns:** `void`
sourceraw docstring

titlecljs

(title webview-view)

View title displayed in the UI.

The view title is initially taken from the extension package.json contribution.

View title displayed in the UI.

The view title is initially taken from the extension `package.json` contribution.
sourceraw docstring

view-typecljs

(view-type webview-view)

Identifies the type of the webview view, such as 'hexEditor.dataView'.

Identifies the type of the webview view, such as `'hexEditor.dataView'`.
sourceraw docstring

visible?cljs

(visible? webview-view)

Tracks if the webview is currently visible.

Views are visible when they are on the screen and expanded.

Tracks if the webview is currently visible.

Views are visible when they are on the screen and expanded.
sourceraw docstring

webviewcljs

(webview webview-view)

The underlying webview for the view.

The underlying webview for the view.
sourceraw docstring

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

× close