zhangyiss/FTXUI
1
0
Fork 0
mirror of https://github.com/ArthurSonzogni/FTXUI.git synced 2025-06-25 00:52:09 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
fe86d06595
FTXUI/doc/module.md
ArthurSonzogni a8eda59d98
Some checks are pending
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (cl, cl, windows-latest) (push) Waiting to run
Details
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (clang, clang++, macos-latest) (push) Waiting to run
Details
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (clang, clang++, ubuntu-latest) (push) Waiting to run
Details
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (gcc, g++, macos-latest) (push) Waiting to run
Details
Build / Bazel, ${{ matrix.cxx }}, ${{ matrix.os }} (gcc, g++, ubuntu-latest) (push) Waiting to run
Details
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (cl, Windows MSVC, windows-latest) (push) Waiting to run
Details
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (gcc, Linux GCC, ubuntu-latest) (push) Waiting to run
Details
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (llvm, llvm-cov gcov, Linux Clang, ubuntu-latest) (push) Waiting to run
Details
Build / CMake, ${{ matrix.compiler }}, ${{ matrix.os }} (llvm, llvm-cov gcov, MacOS clang, macos-latest) (push) Waiting to run
Details
Documentation / documentation (push) Waiting to run
Details
Improve/Fix the documentation page.
2025-05-31 23:19:18 +02:00

1.5 KiB
Raw Blame History

Modules

title-img

FTXUI is organized into three modules, each building upon the previous:

  1. ftxui/screen - Low-level rendering
  2. ftxui/dom - Layout and composition
  3. ftxui/component - User interaction

ftxui/screen

Defines:

  • ftxui::Screen: a 2D grid of styled characters.
  • ftxui::Pixel: the unit of rendering.
  • Helpers like ftxui::Color and Dimension.

Use for direct terminal drawing and styling.

ftxui/dom

Provides:

  • ftxui::Element: a tree structure for layout and UI.
  • Composable and responsive elements.
  • Render() to draw onto a Screen.

Ideal for structured, styled UIs.

ftxui/component

Adds:

  • ftxui::Component: stateful, interactive widgets.
  • Built-ins: Checkbox, Input, Menu, Button.
  • Supports keyboard/cursor input and composition.

Use for interactive apps.

Modules can be used independently, or together: screen → dom → component.