Skip to main content

modules/window/treeView

Interfaces​

TreeDataProvider​

Defined in: modules/window/treeView.d.ts:41

Dynamic data-source abstraction layer feeding nested labels, icons, badges, and async child streams to the UI.

Properties​

onItemClick?​

optional onItemClick?: (item) => void

Defined in: modules/window/treeView.d.ts:51

Optional: Triggered when the user clicks on a tree item.

Parameters​
item​

TreeItem

The item that was clicked.

Returns​

void

Methods​

getChildren()​

getChildren(element?): Promise<TreeItem[]>

Defined in: modules/window/treeView.d.ts:46

Called to get root items (if element is undefined) or children of a specific item.

Parameters​
element?​

TreeItem

The parent item, or undefined if requesting the root elements.

Returns​

Promise<TreeItem[]>

A promise resolving to an array of TreeItems.

TreeItem​

Defined in: modules/window/treeView.d.ts:8

Represents an individual node within a custom Tree View.

Properties​

badge?​

optional badge?: string

Defined in: modules/window/treeView.d.ts:22

Small text badge (e.g., '3', 'M') displayed at the end of the row.

badgeColor?​

optional badgeColor?: string

Defined in: modules/window/treeView.d.ts:25

CSS color for the badge (e.g., '#ff0000', 'var(--ms-error)').

collapsibleState​

collapsibleState: "none" | "expanded" | "collapsed"

Defined in: modules/window/treeView.d.ts:31

Dictates whether this node has children and its initial visual state.

contextValue?​

optional contextValue?: string

Defined in: modules/window/treeView.d.ts:34

Context value used for registering right-click context menus later.

description?​

optional description?: string

Defined in: modules/window/treeView.d.ts:16

Dimmed text displayed after the label.

icon?​

optional icon?: string

Defined in: modules/window/treeView.d.ts:19

Icon name (matches your IconRegistry) to display alongside the item.

id​

id: string

Defined in: modules/window/treeView.d.ts:10

Unique identifier for the item.

label​

label: string

Defined in: modules/window/treeView.d.ts:13

Primary text displayed for the node.

tooltip?​

optional tooltip?: string

Defined in: modules/window/treeView.d.ts:28

Tooltip displayed when the user hovers over the item.

TreeView​

Defined in: modules/window/treeView.d.ts:69

Handle contract returned to extensions when instantiating a custom tree interface. Exposes standard lifecycle modifiers allowing plugins to dynamically control states.

Properties​

id​

readonly id: string

Defined in: modules/window/treeView.d.ts:71

The unique channel identifier matching this structural panel slot.

title​

title: string

Defined in: modules/window/treeView.d.ts:74

Title text rendered dynamically inside the sidebar container panel wrapper.

Methods​

dispose()​

dispose(): void

Defined in: modules/window/treeView.d.ts:77

Safe destructor sequence removing this tree container context immediately from the core system state.

Returns​

void

TreeViewOptions​

Defined in: modules/window/treeView.d.ts:57

Metadata configuration settings supplied by extensions during custom Tree initialization.

Properties​

title?​

optional title?: string

Defined in: modules/window/treeView.d.ts:62

Natural text caption rendered visible to users inside the sidebar header.

treeDataProvider​

treeDataProvider: TreeDataProvider

Defined in: modules/window/treeView.d.ts:59

The data provider that supplies the tree data.

References​

ActivityBarItemOptions​

Re-exports ActivityBarItemOptions

app​

Re-exports app

authentication​

Re-exports authentication

BookmarkFolder​

Re-exports BookmarkFolder

CommandMetadata​

Re-exports CommandMetadata

commands​

Re-exports commands

CommitOptions​

Re-exports CommitOptions

ConfigurationProperty​

Re-exports ConfigurationProperty

CopyOptions​

Re-exports CopyOptions

Diagnostic​

Re-exports Diagnostic

DiagnosticCollection​

Re-exports DiagnosticCollection

DiagnosticSeverity​

Re-exports DiagnosticSeverity

Disposable​

Re-exports Disposable

DocumentSymbol​

Re-exports DocumentSymbol

ExtensionContext​

Re-exports ExtensionContext

ExtensionInfo​

Re-exports ExtensionInfo

extensions​

Re-exports extensions

FileDecoration​

Re-exports FileDecoration

FileFilter​

Re-exports FileFilter

FileStat​

Re-exports FileStat

FileSystemAPI​

Re-exports FileSystemAPI

FindOptions​

Re-exports FindOptions

fs​

Re-exports fs

git​

Re-exports git

GitBranch​

Re-exports GitBranch

GitChangedFile​

Re-exports GitChangedFile

GitCommit​

Re-exports GitCommit

GitFileStatus​

Re-exports GitFileStatus

GitHubUser​

Re-exports GitHubUser

GitRepository​

Re-exports GitRepository

GitSortMode​

Re-exports GitSortMode

GitStash​

Re-exports GitStash

IConfigurationSection​

Re-exports IConfigurationSection

IconThemeDefinition​

Re-exports IconThemeDefinition

IconThemeMap​

Re-exports IconThemeMap

InputBoxOptions​

Re-exports InputBoxOptions

languages​

Re-exports languages

lsp​

Re-exports lsp

LspServerConfig​

Re-exports LspServerConfig

Re-exports MenuItem

Re-exports menus

ModalOptions​

Re-exports ModalOptions

MSCodeUIColors​

Re-exports MSCodeUIColors

MultiPickerOptions​

Re-exports MultiPickerOptions

NotificationAction​

Re-exports NotificationAction

OutputChannel​

Re-exports OutputChannel

PickerOptions​

Re-exports PickerOptions

Position​

Re-exports Position

ProgressNotification​

Re-exports ProgressNotification

QuickPickItem​

Re-exports QuickPickItem

QuickPickOptions​

Re-exports QuickPickOptions

RecentWorkspace​

Re-exports RecentWorkspace

ReplaceOptions​

Re-exports ReplaceOptions

ResolvedIcon​

Re-exports ResolvedIcon

Re-exports search

SearchFileResult​

Re-exports SearchFileResult

SearchMatch​

Re-exports SearchMatch

Selection​

Re-exports Selection

SettingOption​

Re-exports SettingOption

SettingType​

Re-exports SettingType

SidebarPanelDef​

Re-exports SidebarPanelDef

SidebarPanelHeader​

Re-exports SidebarPanelHeader

SidebarSectionContent​

Re-exports SidebarSectionContent

SidebarSectionContext​

Re-exports SidebarSectionContext

SidebarSectionDef​

Re-exports SidebarSectionDef

SidebarState​

Re-exports SidebarState

SilentSearchOptions​

Re-exports SilentSearchOptions

StashOptions​

Re-exports StashOptions

StatusBarAlignment​

Re-exports StatusBarAlignment

StatusBarItemController​

Re-exports StatusBarItemController

StatusBarItemOptions​

Re-exports StatusBarItemOptions

SymbolKind​

Re-exports SymbolKind

SymbolProvider​

Re-exports SymbolProvider

Tab​

Re-exports Tab

TabDiffData​

Re-exports TabDiffData

TabOptions​

Re-exports TabOptions

TabType​

Re-exports TabType

TaskExecution​

Re-exports TaskExecution

TaskOptions​

Re-exports TaskOptions

tasks​

Re-exports tasks

Terminal​

Re-exports Terminal

TerminalExitStatus​

Re-exports TerminalExitStatus

TerminalOptions​

Re-exports TerminalOptions

termis​

Re-exports termis

TermisView​

Re-exports TermisView

TextDocument​

Re-exports TextDocument

TextEditor​

Re-exports TextEditor

TextEditorEdit​

Re-exports TextEditorEdit

TextEditorOptions​

Re-exports TextEditorOptions

ThemeDefinition​

Re-exports ThemeDefinition

themes​

Re-exports themes

TokenColor​

Re-exports TokenColor

window​

Re-exports window

workspace​

Re-exports workspace

WorkspaceConfiguration​

Re-exports WorkspaceConfiguration

WorkspaceFolder​

Re-exports WorkspaceFolder

WriteOptions​

Re-exports WriteOptions