Mirror/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-09-28 16:29:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Improve/Fix the documentation page.

Browse Source
This commit is contained in:
ArthurSonzogni
2025-05-31 23:19:18 +02:00
parent 2f0afe7b14
commit a8eda59d98
10 changed files with 459 additions and 83 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
doc/module.md
View File

@@ -4,13 +4,13 @@
FTXUI is organized into three modules, each building upon the previous:
1. @subpage module-screen — low-level rendering
2. @subpage module-dom — layout and composition
3. @subpage module-component — user interaction
1. [ftxui/screen](#module-screen) - Low-level rendering
2. [ftxui/dom](#module-dom) - Layout and composition
3. [ftxui/component](#module-component) - User interaction
---
[ @subpage module-screen ]
# ftxui/screen
Defines:
@@ -20,9 +20,18 @@ Defines:
Use for direct terminal drawing and styling.
<div class="section_buttons">
| Next |
|--------------------------------------:|
| [Documentation](module-screen.html) |
</div>
---
[ @subpage module-dom ]
# ftxui/dom
Provides:
@@ -32,9 +41,17 @@ Provides:
Ideal for structured, styled UIs.
---
<div class="section_buttons">
[ @subpage module-component ]
| Next |
|--------------------------------------:|
| [Documentation](module-dom.html) |
</div>
---
# ftxui/component
Adds:
@@ -44,6 +61,14 @@ Adds:
Use for interactive apps.
<div class="section_buttons">
| Next |
|--------------------------------------:|
| [Documentation](module-component.html) |
</div>
---
Modules can be used independently, or together: `screen → dom → component`.