View source

class TabGroups

package vscode

@:jsRequire("vscode","TabGroups")

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

Variables

read onlyactiveTabGroup:TabGroup

The currently active group.

read onlyall:ReadOnlyArray<TabGroup>

All the groups within the group container.

read onlyonDidChangeTabGroups:Event<TabGroupChangeEvent>

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

read onlyonDidChangeTabs:Event<TabChangeEvent>

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

Methods

close(tab:EitherType<Tab, ReadOnlyArray<Tab>>, ?preserveFocus:Bool):Thenable<Bool>

close(tabGroup:EitherType<TabGroup, ReadOnlyArray<TabGroup>>, ?preserveFocus:Bool):Thenable<Bool>

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

Parameters:

tab

The tab to close.

preserveFocus

When true focus will remain in its current position. If false it will jump to the next tab.

Returns:

A promise that resolves to true when all tabs have been closed.