Liking cljdoc? Tell your friends :D

dots.vscode.tree-item

A tree item is an UI element of the tree. Tree items are created by the {@link TreeDataProvider data provider}.

A tree item is an UI element of the tree. Tree items are created by the {@link TreeDataProvider data provider}.
raw docstring

accessibility-informationcljs

(accessibility-information tree-item)

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.

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.
sourceraw docstring

checkbox-statecljs

(checkbox-state tree-item)

{@link TreeItemCheckboxState TreeItemCheckboxState} of the tree item. {@link TreeDataProvider.onDidChangeTreeData onDidChangeTreeData} should be fired when {@link TreeItem.checkboxState checkboxState} changes.

{@link TreeItemCheckboxState TreeItemCheckboxState} of the tree item.
{@link TreeDataProvider.onDidChangeTreeData onDidChangeTreeData} should be fired when {@link TreeItem.checkboxState checkboxState} changes.
sourceraw docstring

collapsible-statecljs

(collapsible-state tree-item)

{@link TreeItemCollapsibleState } of the tree item.

{@link TreeItemCollapsibleState } of the tree item.
sourceraw docstring

commandcljs

(command tree-item)

The {@link 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.

The {@link 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.
sourceraw docstring

context-valuecljs

(context-value 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.

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`.
```json
"contributes": {
  "menus": {
    "view/item/context": [
      {
        "command": "extension.deleteFolder",
        "when": "viewItem == folder"
      }
    ]
  }
}
```
This will show action `extension.deleteFolder` only for items with `contextValue` is `folder`.
sourceraw docstring

description?cljs

(description? tree-item)

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.

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.
sourceraw docstring

icon-pathcljs

(icon-path tree-item)

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

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).
sourceraw docstring

idcljs

(id tree-item)

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.

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.
sourceraw docstring

labelcljs

(label tree-item)

A human-readable string describing this item. When falsy, it is derived from {@link TreeItem.resourceUri resourceUri}.

A human-readable string describing this item. When `falsy`, it is derived from {@link TreeItem.resourceUri resourceUri}.
sourceraw docstring

resource-uricljs

(resource-uri tree-item)

The {@link Uri } of the resource representing this item.

Will be used to derive the {@link TreeItem.label label}, when it is not provided. Will be used to derive the icon from current file icon theme, when {@link TreeItem.iconPath iconPath} has {@link ThemeIcon } value.

The {@link Uri } of the resource representing this item.

Will be used to derive the {@link TreeItem.label label}, when it is not provided.
Will be used to derive the icon from current file icon theme, when {@link TreeItem.iconPath iconPath} has {@link ThemeIcon } value.
sourceraw docstring

set-accessibility-information!cljs

(set-accessibility-information! tree-item value)

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.

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.
sourceraw docstring

set-checkbox-state!cljs

(set-checkbox-state! tree-item value)

{@link TreeItemCheckboxState TreeItemCheckboxState} of the tree item. {@link TreeDataProvider.onDidChangeTreeData onDidChangeTreeData} should be fired when {@link TreeItem.checkboxState checkboxState} changes.

{@link TreeItemCheckboxState TreeItemCheckboxState} of the tree item.
{@link TreeDataProvider.onDidChangeTreeData onDidChangeTreeData} should be fired when {@link TreeItem.checkboxState checkboxState} changes.
sourceraw docstring

set-collapsible-state!cljs

(set-collapsible-state! tree-item value)

{@link TreeItemCollapsibleState } of the tree item.

{@link TreeItemCollapsibleState } of the tree item.
sourceraw docstring

set-command!cljs

(set-command! tree-item value)

The {@link 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.

The {@link 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.
sourceraw docstring

set-context-value!cljs

(set-context-value! tree-item value)

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.

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`.
```json
"contributes": {
  "menus": {
    "view/item/context": [
      {
        "command": "extension.deleteFolder",
        "when": "viewItem == folder"
      }
    ]
  }
}
```
This will show action `extension.deleteFolder` only for items with `contextValue` is `folder`.
sourceraw docstring

set-description!cljs

(set-description! tree-item value)

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.

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.
sourceraw docstring

set-icon-path!cljs

(set-icon-path! tree-item value)

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

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).
sourceraw docstring

set-id!cljs

(set-id! tree-item value)

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.

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.
sourceraw docstring

set-label!cljs

(set-label! tree-item value)

A human-readable string describing this item. When falsy, it is derived from {@link TreeItem.resourceUri resourceUri}.

A human-readable string describing this item. When `falsy`, it is derived from {@link TreeItem.resourceUri resourceUri}.
sourceraw docstring

set-resource-uri!cljs

(set-resource-uri! tree-item value)

The {@link Uri } of the resource representing this item.

Will be used to derive the {@link TreeItem.label label}, when it is not provided. Will be used to derive the icon from current file icon theme, when {@link TreeItem.iconPath iconPath} has {@link ThemeIcon } value.

The {@link Uri } of the resource representing this item.

Will be used to derive the {@link TreeItem.label label}, when it is not provided.
Will be used to derive the icon from current file icon theme, when {@link TreeItem.iconPath iconPath} has {@link ThemeIcon } value.
sourceraw docstring

set-tooltip!cljs

(set-tooltip! tree-item value)

The tooltip text when you hover over this item.

The tooltip text when you hover over this item.
sourceraw docstring

tooltipcljs

(tooltip tree-item)

The tooltip text when you hover over this item.

The tooltip text when you hover over this item.
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close