FTXUI/README.md

Documentation · Report Bug · Examples . Request Feature · Send a Pull Request

FTXUI

Functional Terminal (X) User interface

A simple C++ library for terminal based user interface.

Feature

• Functional style. Inspired by [1] and React
• Simple and elegant syntax (in my opinion).
• Support for UTF8 and fullwidth chars (→ 测试).
• No dependencies.
• Cross platform. Linux/mac (main target), Windows (experimental thanks to contributors), WebAssembly.
• Keyboard & mouse navigation.

Operating systems

• Webassembly
• Linux
• MacOS
• Windows

Example

  vbox({
    hbox({
      text("left") | border,
      text("middle") | border | flex,
      text("right") | border,
    }),
    gauge(0.5) | border,
  });

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

Documentation

• Starter example project
• Documentation
• Examples (WebAssembly)
• Build using CMake
• Build using nxxm

Project using FTXUI

Feel free to add your projects here:

• git-tui
• rgb-tui
• chrome-log-beautifier
• x86-64 CPU Architecture Simulation
• ltuiny
• i3-termdialogs
• Just-Fast
• simpPRU
• Pigeon ROS TUI
• hastur
• CryptoCalculator
• todoman
• TimeAccumulator
• vantage
• tabdeeli

Hosted on

• github
• gitlab

External package

It is highly recommanded to use cmake FetchContent to depends on FTXUI. This way you can specify which commit you would like to depends on.

If you don't, the following packages have been created:

• vcpkg (soon)
• Arch Linux PKGBUILD.