A human-readable string describing this item
TreeItemCollapsibleState of the tree item. Default is TreeItemCollapsibleState.None
The Uri of the resource representing this item.
TreeItemCollapsibleState of the tree item. Default is TreeItemCollapsibleState.None
A human-readable string describing this item. When falsy
, it is derived from resourceUri.
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.
If not provided, an id is generated using the tree item's label. Note that when labels change, ids will change and that selection and expansion state cannot be kept stable anymore.
The icon path or ThemeIcon for the tree item.
When falsy
, Folder Theme Icon is assigned, if item is collapsible otherwise File Theme Icon.
When a file or folder ThemeIcon is specified, icon is derived from the current file icon theme for the specified theme icon using resourceUri (if provided).
A human-readable string which is rendered less prominent.
When true
, it is derived from resourceUri and when falsy
, it is not shown.
The tooltip text when you hover over this item.
The Command that should be executed when the tree item is selected.
Please use vscode.open
or vscode.diff
as command IDs when the tree item is opening
something in the editor. Using these commands ensures that the resulting editor will
appear consistent with how other built-in trees open editors.
TreeItemCollapsibleState of the tree item.
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
.
"contributes": {
"menus": {
"view/item/context": [
{
"command": "extension.deleteFolder",
"when": "viewItem == folder"
}
]
}
}
This will show action extension.deleteFolder
only for items with contextValue
is folder
.
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.
TreeItemCheckboxState of the tree item. onDidChangeTreeData should be fired when checkboxState changes.
A tree item is an UI element of the tree. Tree items are created by the data provider.