TreeItem$Typings extension
Properties
-
accessibilityInformation
↔ AccessibilityInformation
-
Accessibility information used when screen reader interacts with this tree item.
Generally, a TreeItem has no need to set the
role of the accessibilityInformation;
however, there are cases where a TreeItem is not displayed in a tree-like way where setting the role may make sense.
getter/setter pair
-
checkboxState
↔ Object
-
{@link TreeItemCheckboxState TreeItemCheckboxState} of the tree item.
{@link TreeDataProvider.onDidChangeTreeData onDidChangeTreeData} should be fired when {@link TreeItem.checkboxState checkboxState} changes.
getter/setter pair
-
collapsibleState
↔ TreeItemCollapsibleState
-
{@link TreeItemCollapsibleState} of the tree item.
getter/setter pair
-
command
↔ Command
-
The {@link Command} that should be executed when the tree item is selected.
getter/setter pair
-
contextValue
↔ String
-
Context value of the tree item. This can be used to contribute item specific actions in the tree.
For example, a tree item is given a context value as
folder. When contributing actions to view/item/context
using menus extension point, you can specify context value for key viewItem in when expression like viewItem == folder.
getter/setter pair
-
description
↔ Object
-
A human-readable string which is rendered less prominent.
When
true, it is derived from {@link TreeItem.resourceUri resourceUri} and when falsy, it is not shown.
getter/setter pair
-
iconPath
↔ Object
-
The icon path or {@link ThemeIcon} for the tree item.
When
falsy, {@link ThemeIcon.Folder Folder Theme Icon} is assigned, if item is collapsible otherwise {@link ThemeIcon.File File Theme Icon}.
When a file or folder {@link ThemeIcon} is specified, icon is derived from the current file icon theme for the specified theme icon using {@link TreeItem.resourceUri resourceUri} (if provided).
getter/setter pair
-
id
↔ String
-
Optional id for the tree item that has to be unique across tree. The id is used to preserve the selection and expansion state of the tree item.
getter/setter pair
-
label
↔ Object
-
A human-readable string describing this item. When
falsy, it is derived from {@link TreeItem.resourceUri resourceUri}.
getter/setter pair
-
resourceUri
↔ Uri
-
The {@link Uri} of the resource representing this item.
getter/setter pair
-
tooltip
↔ dynamic
-
The tooltip text when you hover over this item.
getter/setter pair
