Liking cljdoc? Tell your friends :D

dots.vscode.tab-groups

Represents the main editor area which consists of multiple groups which contain tabs.

Represents the main editor area which consists of multiple groups which contain tabs.
raw docstring

active-tab-groupcljs

(active-tab-group tab-groups)

The currently active group.

The currently active group.
sourceraw docstring

allcljs

(all tab-groups)

All the groups within the group container.

All the groups within the group container.
sourceraw docstring

closecljs

(close tab-groups tab)
(close tab-groups tab-group)
(close tab-groups tab preserve-focus?)
(close tab-groups tab-group preserve-focus?)

Closes the tab. This makes the tab object invalid and the tab should no longer be used for further actions. Note: In the case of a dirty tab, a confirmation dialog will be shown which may be cancelled. If cancelled the tab is still valid Closes the tab group. This makes the tab group object invalid and the tab group should no longer be used for further actions.

Parameters:

  • tab: Tab | readonly Tab[] - The tab to close.
  • tab-group: TabGroup | readonly TabGroup[] - The tab group to close.
  • preserve-focus?: boolean | undefined - When true focus will remain in its current position.

Returns: Thenable<boolean> - A promise that resolves to true when all tab groups have been closed.

Closes the tab. This makes the tab object invalid and the tab
should no longer be used for further actions.
Note: In the case of a dirty tab, a confirmation dialog will be shown which may be cancelled. If cancelled the tab is still valid
Closes the tab group. This makes the tab group object invalid and the tab group
should no longer be used for further actions.

**Parameters:**
- `tab`: `Tab | readonly Tab[]` - The tab to close.
- `tab-group`: `TabGroup | readonly TabGroup[]` - The tab group to close.
- `preserve-focus?`: `boolean | undefined` - When `true` focus will remain in its current position.

**Returns:** `Thenable<boolean>` - A promise that resolves to `true` when all tab groups have been closed.
sourceraw docstring

on-did-change-tab-groupscljs

(on-did-change-tab-groups tab-groups)
(on-did-change-tab-groups tab-groups listener)
(on-did-change-tab-groups tab-groups listener this-args)
(on-did-change-tab-groups tab-groups listener this-args disposables)

An {@link Event event} which fires when {@link TabGroup tab groups} have changed.

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.

An {@link Event event} which fires when {@link TabGroup tab groups} have changed.

**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-change-tabscljs

(on-did-change-tabs tab-groups)
(on-did-change-tabs tab-groups listener)
(on-did-change-tabs tab-groups listener this-args)
(on-did-change-tabs tab-groups listener this-args disposables)

An {@link Event event} which fires when {@link Tab tabs} have changed.

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.

An {@link Event event} which fires when {@link Tab tabs} have changed.

**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

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

× close