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
Files
9529cac35212b83ac06f0545e6069be1cd80a23a
textual/docs/widgets/tree.md
Will McGugan f5e779c4c4 tabbed content widget (#2059) 
* tabbed content widget

* TabbedContent widget and docs

* missing docs

* fix active

* doc fix

* test fix

* additional test

* test for render_str

* docstring

* changelog

* doc update

* changelog

* fix bad optimization

* Update docs/widgets/tabbed_content.md

Co-authored-by: Dave Pearson <davep@davep.org>

* fix for empty initial

* docstrings

* Update src/textual/widgets/_content_switcher.py

Co-authored-by: Dave Pearson <davep@davep.org>

* docstring

* remove log

* permit nested tabs

* renamed TabsCleared to Cleared

* added tests, fix types on click

* tests

* fix broken test

* fix for nested tabs

---------

Co-authored-by: Dave Pearson <davep@davep.org>
2023-03-18 10:38:41 +00:00

1.7 KiB
Raw Blame History

Tree

A tree control widget.

  • Focusable
  • Container

Example

The example below creates a simple tree.

=== "Output"

```{.textual path="docs/examples/widgets/tree.py"}
```

=== "tree.py"

```python
--8<-- "docs/examples/widgets/tree.py"
```

Tree widgets have a "root" attribute which is an instance of a [TreeNode][textual.widgets.tree.TreeNode]. Call [add()][textual.widgets.tree.TreeNode.add] or [add_leaf()][textual.widgets.tree.TreeNode.add_leaf] to add new nodes underneath the root. Both these methods return a TreeNode for the child which you can use to add additional levels.

Reactive Attributes

Name Type Default Description
show_root bool True Show the root node.
show_guides bool True Show guide lines between levels.
guide_depth int 4 Amount of indentation between parent and child.

Messages

::: textual.widgets.Tree.NodeCollapsed

::: textual.widgets.Tree.NodeExpanded

::: textual.widgets.Tree.NodeHighlighted

::: textual.widgets.Tree.NodeSelected

Bindings

The tree widget defines the following bindings:

::: textual.widgets.Tree.BINDINGS options: show_root_heading: false show_root_toc_entry: false

Component Classes

The tree widget provides the following component classes:

::: textual.widgets.Tree.COMPONENT_CLASSES options: show_root_heading: false show_root_toc_entry: false

See Also

  • [Tree][textual.widgets.Tree] code reference
  • [TreeNode][textual.widgets.tree.TreeNode] code reference