From b7d628fca5b84bf330f51fe9f487eccf63d775e9 Mon Sep 17 00:00:00 2001 From: Will McGugan Date: Sun, 20 Nov 2022 17:32:37 +0000 Subject: [PATCH] docs update --- docs/widgets/directory_tree.md | 15 ++++++++--- docs/widgets/tree.md | 48 +++++++++++++++++++++++++++++----- 2 files changed, 52 insertions(+), 11 deletions(-) diff --git a/docs/widgets/directory_tree.md b/docs/widgets/directory_tree.md index 2c5e327c1..2baf73e75 100644 --- a/docs/widgets/directory_tree.md +++ b/docs/widgets/directory_tree.md @@ -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 diff --git a/docs/widgets/tree.md b/docs/widgets/tree.md index d87e1a966..801d993f0 100644 --- a/docs/widgets/tree.md +++ b/docs/widgets/tree.md @@ -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