kotlin-vscode/vscode/TreeItem

TreeItem

open class TreeItem(source)

A tree item is an UI element of the tree. Tree items are created by the data provider.

Online Documentation

Constructors

TreeItem

constructor(label: JsAny, collapsibleState: TreeItemCollapsibleState = definedExternally)

constructor(resourceUri: Uri, collapsibleState: TreeItemCollapsibleState = definedExternally)

Properties

accessibilityInformation

var 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.

collapsibleState

var collapsibleState: TreeItemCollapsibleState?

TreeItemCollapsibleState of the tree item.

command

var command: Command?

The Command that should be executed when the tree item is selected.

contextValue

var 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.

description

var description: JsAny?

A human-readable string which is rendered less prominent. When true, it is derived from resourceUri and when falsy, it is not shown.

iconPath

var iconPath: JsAny?

The icon path or ThemeIcon for the tree item. When falsy, Folder Theme Icon} is assigned, if item is collapsible otherwise {@link 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).

var 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.

label

var label: JsAny?

A human-readable string describing this item. When falsy, it is derived from resourceUri.

resourceUri

var resourceUri: Uri?

The Uri of the resource representing this item.

tooltip

var tooltip: JsAny?

The tooltip text when you hover over this item.