Creates an instance of ChatTreeItem.
Optional
metadata: anyOptional
accessibilityAccessibility 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.
Optional
checkboxTreeItemCheckboxState TreeItemCheckboxState of the tree item. TreeDataProvider.onDidChangeTreeData onDidChangeTreeData should be fired when TreeItem.checkboxState checkboxState changes.
Optional
Readonly
accessibilityInformation?: AccessibilityInformationAccessibility information used when screen readers interact with this checkbox
Readonly
state: TreeItemCheckboxStateThe TreeItemCheckboxState of the tree item
Optional
Readonly
tooltip?: stringA tooltip for the checkbox
Readonly
collapsibleOptional
commandThe 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.
Optional
contextContext 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
.
Optional
descriptionA human-readable string which is rendered less prominent.
When true
, it is derived from resourceUri and when falsy
, it is not shown.
Optional
iconThe icon path or ThemeIcon for the tree item.
When falsy
, ThemeIcon.Folder Folder Theme Icon is assigned, if item is collapsible otherwise ThemeIcon.File 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).
Readonly
idReadonly
labelOptional
Readonly
metadataOptional
resourceThe Uri of the resource representing this item.
Will be used to derive the TreeItem.label label, when it is not provided. Will be used to derive the icon from current file icon theme, when TreeItem.iconPath iconPath has ThemeIcon value.
Optional
tooltipThe tooltip text when you hover over this item.
Readonly
type
Description placeholder
ChatTreeItem