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

Merge branch 'main' into doc-improvements

Browse Source
This commit is contained in:
Rodrigo Girão Serrão
2023-01-26 13:55:34 +00:00
parent b37517c400 d8e6cfdd50
commit bc729033c8
27 changed files with 1087 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/tree_node.md
View File

@@ -1 +1 @@
::: textual.widgets.TreeNode
::: textual.widgets.tree.TreeNode

21
docs/index.md
View File

@@ -1,17 +1,24 @@
# Introduction
Welcome to the [Textual](https://github.com/Textualize/textual) framework documentation. Built with ❤️ by [Textualize.io](https://www.textualize.io)
Welcome to the [Textual](https://github.com/Textualize/textual) framework documentation.
!!! tip
See the navigation links in the header or side-bars. Click the :octicons-three-bars-16: button (top left) on mobile.
## In a hurry?
[Get started](./getting_started.md){ .md-button .md-button--primary } or go straight to the [Tutorial](./tutorial.md)
See the navigation links in the header or side-bars. Click the :octicons-three-bars-16: button (top left) on mobile.
[Get started](./getting_started.md){ .md-button .md-button--primary } or [Tutorial](./tutorial.md){ .md-button .md-button--secondary }
## What is Textual?
Textual is a framework for building applications that run within your terminal. Text User Interfaces (TUIs) have a number of advantages over web and desktop apps.
Textual is a *Rapid Application Development* framework for Python, built by [Textualize.io](https://www.textualize.io).
Build sophisticated user interfaces with a simple Python API. Run your apps in the terminal and (*coming soon*) a web browser.
<div class="grid cards" markdown>
@@ -26,7 +33,7 @@ Textual is a framework for building applications that run within your terminal.
---
Low system requirements. Run Textual on a single board computer if you want to.
Run Textual on a single board computer if you want to.
@@ -53,7 +60,7 @@ Textual is a framework for building applications that run within your terminal.
- :material-scale-balance:{ .lg .middle } __Open Source, MIT__
- :material-scale-balance:{ .lg .middle } __Open Source__
---

4
docs/widgets/tree.md
View File

@@ -21,7 +21,7 @@ The example below creates a simple tree.
--8<-- "docs/examples/widgets/tree.py"
```
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.
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
@@ -63,4 +63,4 @@ The tree widget provides the following component classes:
## See Also
* [Tree][textual.widgets.Tree] code reference
* [TreeNode][textual.widgets.TreeNode] code reference
* [TreeNode][textual.widgets.tree.TreeNode] code reference