dots.vscode.tree-view-options
Options for creating a {@link TreeView }
Options for creating a {@link TreeView }
can-select-many?cljs
(can-select-many? tree-view-options)Whether the tree supports multi-select. When the tree supports multi-select and a command is executed from the tree, the first argument to the command is the tree item that the command was executed on and the second argument is an array containing all selected tree items.
Returns: boolean | undefined
Whether the tree supports multi-select. When the tree supports multi-select and a command is executed from the tree, the first argument to the command is the tree item that the command was executed on and the second argument is an array containing all selected tree items. **Returns:** `boolean | undefined`
drag-and-drop-controllercljs
(drag-and-drop-controller tree-view-options)An optional interface to implement drag and drop in the tree view.
Returns: TreeDragAndDropController<T> | undefined
An optional interface to implement drag and drop in the tree view. **Returns:** `TreeDragAndDropController<T> | undefined`
manage-checkbox-state-manually?cljs
(manage-checkbox-state-manually? tree-view-options)By default, when the children of a tree item have already been fetched, child checkboxes are automatically managed based on the checked state of the parent tree item.
If the tree item is collapsed by default (meaning that the children haven't yet been fetched) then child checkboxes will not be updated.
To override this behavior and manage child and parent checkbox state in the extension, set this to true.
Examples where {@link TreeViewOptions.manageCheckboxStateManually } is false, the default behavior:
-
A tree item is checked, then its children are fetched. The children will be checked.
-
A tree item's parent is checked. The tree item and all of it's siblings will be checked.
- [ ] Parent
- [ ] Child 1
- [ ] Child 2 When the user checks Parent, the tree will look like this:
- [x] Parent
- [x] Child 1
- [x] Child 2
- A tree item and all of it's siblings are checked. The parent will be checked.
- [ ] Parent
- [ ] Child 1
- [ ] Child 2 When the user checks Child 1 and Child 2, the tree will look like this:
- [x] Parent
- [x] Child 1
- [x] Child 2
- A tree item is unchecked. The parent will be unchecked.
- [x] Parent
- [x] Child 1
- [x] Child 2 When the user unchecks Child 1, the tree will look like this:
- [ ] Parent
- [ ] Child 1
- [x] Child 2
Returns: boolean | undefined
By default, when the children of a tree item have already been fetched, child checkboxes are automatically managed based on the checked state of the parent tree item.
If the tree item is collapsed by default (meaning that the children haven't yet been fetched) then child checkboxes will not be updated.
To override this behavior and manage child and parent checkbox state in the extension, set this to `true`.
Examples where {@link TreeViewOptions.manageCheckboxStateManually } is false, the default behavior:
1. A tree item is checked, then its children are fetched. The children will be checked.
2. A tree item's parent is checked. The tree item and all of it's siblings will be checked.
- [ ] Parent
- [ ] Child 1
- [ ] Child 2
When the user checks Parent, the tree will look like this:
- [x] Parent
- [x] Child 1
- [x] Child 2
3. A tree item and all of it's siblings are checked. The parent will be checked.
- [ ] Parent
- [ ] Child 1
- [ ] Child 2
When the user checks Child 1 and Child 2, the tree will look like this:
- [x] Parent
- [x] Child 1
- [x] Child 2
4. A tree item is unchecked. The parent will be unchecked.
- [x] Parent
- [x] Child 1
- [x] Child 2
When the user unchecks Child 1, the tree will look like this:
- [ ] Parent
- [ ] Child 1
- [x] Child 2
**Returns:** `boolean | undefined`set-can-select-many!cljs
(set-can-select-many! tree-view-options value)Whether the tree supports multi-select. When the tree supports multi-select and a command is executed from the tree, the first argument to the command is the tree item that the command was executed on and the second argument is an array containing all selected tree items.
Whether the tree supports multi-select. When the tree supports multi-select and a command is executed from the tree, the first argument to the command is the tree item that the command was executed on and the second argument is an array containing all selected tree items.
set-drag-and-drop-controller!cljs
(set-drag-and-drop-controller! tree-view-options value)An optional interface to implement drag and drop in the tree view.
An optional interface to implement drag and drop in the tree view.
set-manage-checkbox-state-manually!cljs
(set-manage-checkbox-state-manually! tree-view-options value)By default, when the children of a tree item have already been fetched, child checkboxes are automatically managed based on the checked state of the parent tree item.
If the tree item is collapsed by default (meaning that the children haven't yet been fetched) then child checkboxes will not be updated.
To override this behavior and manage child and parent checkbox state in the extension, set this to true.
Examples where {@link TreeViewOptions.manageCheckboxStateManually } is false, the default behavior:
-
A tree item is checked, then its children are fetched. The children will be checked.
-
A tree item's parent is checked. The tree item and all of it's siblings will be checked.
- [ ] Parent
- [ ] Child 1
- [ ] Child 2 When the user checks Parent, the tree will look like this:
- [x] Parent
- [x] Child 1
- [x] Child 2
- A tree item and all of it's siblings are checked. The parent will be checked.
- [ ] Parent
- [ ] Child 1
- [ ] Child 2 When the user checks Child 1 and Child 2, the tree will look like this:
- [x] Parent
- [x] Child 1
- [x] Child 2
- A tree item is unchecked. The parent will be unchecked.
- [x] Parent
- [x] Child 1
- [x] Child 2 When the user unchecks Child 1, the tree will look like this:
- [ ] Parent
- [ ] Child 1
- [x] Child 2
By default, when the children of a tree item have already been fetched, child checkboxes are automatically managed based on the checked state of the parent tree item.
If the tree item is collapsed by default (meaning that the children haven't yet been fetched) then child checkboxes will not be updated.
To override this behavior and manage child and parent checkbox state in the extension, set this to `true`.
Examples where {@link TreeViewOptions.manageCheckboxStateManually } is false, the default behavior:
1. A tree item is checked, then its children are fetched. The children will be checked.
2. A tree item's parent is checked. The tree item and all of it's siblings will be checked.
- [ ] Parent
- [ ] Child 1
- [ ] Child 2
When the user checks Parent, the tree will look like this:
- [x] Parent
- [x] Child 1
- [x] Child 2
3. A tree item and all of it's siblings are checked. The parent will be checked.
- [ ] Parent
- [ ] Child 1
- [ ] Child 2
When the user checks Child 1 and Child 2, the tree will look like this:
- [x] Parent
- [x] Child 1
- [x] Child 2
4. A tree item is unchecked. The parent will be unchecked.
- [x] Parent
- [x] Child 1
- [x] Child 2
When the user unchecks Child 1, the tree will look like this:
- [ ] Parent
- [ ] Child 1
- [x] Child 2set-show-collapse-all!cljs
(set-show-collapse-all! tree-view-options value)Whether to show collapse all action or not.
Whether to show collapse all action or not.
set-tree-data-provider!cljs
(set-tree-data-provider! tree-view-options value)A data provider that provides tree data.
A data provider that provides tree data.
show-collapse-all?cljs
(show-collapse-all? tree-view-options)Whether to show collapse all action or not.
Returns: boolean | undefined
Whether to show collapse all action or not. **Returns:** `boolean | undefined`
tree-data-providercljs
(tree-data-provider tree-view-options)A data provider that provides tree data.
Returns: TreeDataProvider<T>
A data provider that provides tree data. **Returns:** `TreeDataProvider<T>`
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close