FTXUI/tutorial.md

Table of content.

• DOM
  • Style
  • Layout
  • Widget.
    • text
    • frame
    • separator
    • gauge
• Components.
  • Input
  • Menu
  • Toggle.

DOM

All the dom element are declared in one header:

#include <ftxui/dom/elements.hpp>

It declares the following set of elements:

// --- Layout ----
Element vbox(Children);
Element hbox(Children);
Element flex();
Element flex(Element);

// --- Widget --
Element text(std::wstring text);
Element separator();
Element gauge(float ratio);
Element frame(Child);
Element frame(Child title, Child content);

// -- Style ---
Element bold(Element);
Element dim(Element);
Element inverted(Element);
Element underlined(Element);
Element blink(Element);
Element color(Color, Element);
Element bgcolor(Color, Element);

// --- Util ---
Element hcenter(Element);
Element vcenter(Element);
Element center(Element);

// --- Util ---
Element nothing(Element element);

Style

A terminal console can usually display colored text and colored background. The text can also have different effects: bold, dim, underlined, inverted, blink.

Element bold(Element);
Element dim(Element);
Element inverted(Element);
Element underlined(Element);
Element blink(Element);
Element color(Color, Element);
Element bgcolor(Color, Element);

Layout

vbox (Vertical-box) and hbox (Horizontal-box) are containers. They are used to compose all the elements together. They will display their children one by one in one direction. Each elements will occupy the space it required plus a fraction of the remaining space dispatched to all the flexible elements.

flex() is used to make an element flexible.

Examples

  hbox(
    frame(text(L"left")),
    flex(frame(text(L"middle"))),
    frame(text(L"right"))
  );

┌────┐┌─────────────────────────────────────────────────────────────────┐┌─────┐
│left││middle                                                           ││right│
└────┘└─────────────────────────────────────────────────────────────────┘└─────┘

  hbox(
    frame(text(L"left")),
    flex(frame(text(L"middle"))),
    flex(frame(text(L"right")))
  );

┌────┐┌───────────────────────────────────┐┌───────────────────────────────────┐
│left││middle                             ││right                              │
└────┘└───────────────────────────────────┘└───────────────────────────────────┘

Widget.

text

The most simple widget. It display a text.

  text(L"I am a piece of text");

I am a piece of text.

frame

Add a border arround an element

frame(text(L"The element"))

┌───────────┐
│The element│
└───────────┘

separator

Display a vertical or horizontal line to visually split the content of a container in two.

frame(hbox(
  vbox(
    text(L"left top"),
    text(L"left bottom")
  ),
  separator(),
  vbox(
    text(L"right top"),
    text(L"right bottom")
  )
));

┌───────────┬────────────┐
│left top   │right top   │
│left bottom│right bottom│
└───────────┴────────────┘

gauge

A gauge. It can be used to represent a progress bar.

frame(gauge(0.5))

┌────────────────────────────────────────────────────────────────────────────┐
│██████████████████████████████████████                                      │
└────────────────────────────────────────────────────────────────────────────┘

Components.

Input

TODO(arthursonzogni): Add Video

Menu

TODO(arthursonzogni): Add Video

Toggle.

TODO(arthursonzogni): Add video