Skip to content

module.md

Latest commit

 

History

History
80 lines (48 loc) · 1.73 KB

module.md

File metadata and controls

80 lines (48 loc) · 1.73 KB
Raw

ftxui {#ftxui}

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

Alternatively, you can use the ftxui umbrella module which includes everything:

  • Header: #include <ftxui/ftxui.hpp>
  • CMake target: ftxui::ftxui
  • Bazel target: @ftxui//:ftxui

ftxui/screen

Defines:

  • ftxui::Screen: a 2D grid of styled characters.
  • ftxui::Cell: 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.