alihan/textual
1
0
Fork 0
mirror of https://github.com/Textualize/textual.git synced 2025-10-17 02:38:12 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs update

Browse Source
This commit is contained in:
Will McGugan
2022-11-20 17:32:37 +00:00
parent 62a1dc60cd
commit b7d628fca5
2 changed files with 52 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/widgets/directory_tree.md
View File

@@ -14,12 +14,19 @@ The example below creates a simple tree to navigate the current working director
--8<-- "docs/examples/widgets/directory_tree.py"
```
## Events
## Messages
| Event | Default handler | Description |
| ------------------- | --------------------------------- | --------------------------------------- |
| `Tree.FileSelected` | `on_directory_tree_file_selected` | Sent when the user selects a file node. |
### FileSelected
The `DirectoryTree.FileSelected` message is sent when the user selects a file in the tree
- [x] Bubbles
#### Attributes
| attribute | type | purpose |
| --------- | ----- | ----------------- |
| `path` | `str` | Path of the file. |
## Reactive Attributes

48
docs/widgets/tree.md
View File

@@ -23,13 +23,6 @@ The example below creates a simple tree.
A each tree widget has a "root" attribute which is an instance of a [TreeNode][textual.widgets.TreeNode]. Call [add()][textual.widgets.TreeNode.add] or [add_leaf()][textual.widgets.TreeNode.add_leaf] to add new nodes underneath the root. Both these methods return a TreeNode for the child, so you can add more levels.
## Events
| Event | Default handler | Description |
| -------------------- | ------------------------ | ------------------------------------------------ |
| `Tree.NodeSelected` | `on_tree_node_selected` | Sent when the user selects a tree node. |
| `Tree.NodeExpanded` | `on_tree_node_expanded` | Sent when the user expands a node in the tree. |
| `Tree.NodeCollapsed` | `on_tree_node_collapsed` | Sent when the user collapsed a node in the tree. |
## Reactive Attributes
@@ -40,6 +33,47 @@ A each tree widget has a "root" attribute which is an instance of a [TreeNode][t
| `guide_depth` | `int` | `4` | Amount of indentation between parent and child. |
## Messages
### NodeSelected
The `Tree.NodeSelected` message is sent when the user selects a tree node.
#### Attributes
| attribute | type | purpose |
| --------- | ------------------------------------ | -------------- |
| `node` | [TreeNode][textual.widgets.TreeNode] | Selected node. |
### NodeExpanded
The `Tree.NodeExpanded` message is sent when the user expands a node in the tree.
#### Attributes
| attribute | type | purpose |
| --------- | ------------------------------------ | -------------- |
| `node` | [TreeNode][textual.widgets.TreeNode] | Expanded node. |
### NodeCollapsed
The `Tree.NodeCollapsed` message is sent when the user expands a node in the tree.
#### Attributes
| attribute | type | purpose |
| --------- | ------------------------------------ | --------------- |
| `node` | [TreeNode][textual.widgets.TreeNode] | Collapsed node. |
## See Also
* [Tree][textual.widgets.Tree] code reference