base on :computer: C++ Functional Terminal User Interface. :heart: <p align="center"> <img src="https://github.com/ArthurSonzogni/FTXUI/assets/4759106/6925b6da-0a7e-49d9-883c-c890e1f36007" alt="Demo image"></img> <br/> <a href="#"><img src="https://img.shields.io/badge/c++-%2300599C.svg?style=flat&logo=c%2B%2B&logoColor=white"></img></a> <a href="http://opensource.org/licenses/MIT"><img src="https://img.shields.io/github/license/arthursonzogni/FTXUI?color=black"></img></a> <a href="#"><img src="https://img.shields.io/github/stars/ArthurSonzogni/FTXUI"></img></a> <a href="#"><img src="https://img.shields.io/github/forks/ArthurSonzogni/FTXUI"></img></a> <a href="#"><img src="https://img.shields.io/github/repo-size/ArthurSonzogni/FTXUI"></img></a> <a href="https://github.com/ArthurSonzogni/FTXUI/graphs/contributors"><img src="https://img.shields.io/github/contributors/arthursonzogni/FTXUI?color=blue"></img></a> <br/> <a href="https://github.com/ArthurSonzogni/FTXUI/issues"><img src="https://img.shields.io/github/issues/ArthurSonzogni/FTXUI"></img></a> <a href="https://repology.org/project/ftxui/versions"><img src="https://repology.org/badge/latest-versions/ftxui.svg" alt="latest packaged version(s)"></a> <a href="https://codecov.io/gh/ArthurSonzogni/FTXUI"> <img src="https://codecov.io/gh/ArthurSonzogni/FTXUI/branch/master/graph/badge.svg?token=C41FdRpNVA"/> </a> <br/> <a href="https://arthursonzogni.github.io/FTXUI/">Documentation</a> · <a href="https://github.com/ArthurSonzogni/FTXUI/issues">Report a Bug</a> · <a href="https://arthursonzogni.github.io/FTXUI/examples/">Examples</a> . <a href="https://github.com/ArthurSonzogni/FTXUI/issues">Request Feature</a> · <a href="https://github.com/ArthurSonzogni/FTXUI/pulls">Send a Pull Request</a> <br/> <a href="https://github.com/ArthurSonzogni/">English</a> | <a href="https://github.com/ArthurSonzogni/ftxui-translations/tree/zh-CH">中文翻译</a> | <a href="https://github.com/ArthurSonzogni/ftxui-translations/tree/zh-CH">繁體中文</a> | <a href="https://github.com/ArthurSonzogni/ftxui-translations/tree/ja">日本語</a> </p> # FTXUI <i>Functional Terminal (X) User interface</i> A simple cross-platform C++ library for terminal based user interfaces! ## Feature * Functional style. Inspired by [1](https://hackernoon.com/building-reactive-terminal-interfaces-in-c-d392ce34e649?gi=d9fb9ce35901) and [React](https://reactjs.org/) * Simple and elegant syntax (in my opinion) * Keyboard & mouse navigation. * Support for [UTF8](https://en.wikipedia.org/wiki/UTF-8) and [fullwidth chars](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) (→ 测试) * Support for animations. [Demo 1](https://arthursonzogni.github.io/FTXUI/examples/?file=component/menu_underline_animated_gallery), [Demo 2](https://arthursonzogni.github.io/FTXUI/examples/?file=component/button_style) * Support for drawing. [Demo](https://arthursonzogni.github.io/FTXUI/examples/?file=component/canvas_animated) * No dependencies. * [C++20 Module support](https://arthursonzogni.github.io/FTXUI/cpp20-modules.html) * **Cross platform**: Linux/MacOS (main target), WebAssembly, Windows (Thanks to contributors!). * Learn by [examples](#documentation), and [tutorials](#documentation) * Multiple packages: - CMake [FetchContent]([https://bewagner.net/programming/2020/05/02/cmake-fetchcontent/](https://cmake.org/cmake/help/latest/module/FetchContent.html)) (preferred) - [Bazel](https://registry.bazel.build/modules/ftxui) - [vcpkg](https://vcpkg.link/ports/ftxui) - [Conan](https://conan.io/center/recipes/ftxui) [Debian package](https://tracker.debian.org/pkg/ftxui) - [Ubuntu package](https://launchpad.net/ubuntu/+source/ftxui) - [Arch Linux](https://aur.archlinux.org/packages/ftxui/) - [OpenSUSE](https://build.opensuse.org/package/show/devel:libraries:c_c++/ftxui) - [XMake](https://xmake.io) repository [package](https://github.com/xmake-io/xmake-repo/blob/dev/packages/f/ftxui/xmake.lua) - [Nix](https://github.com/ArthurSonzogni/FTXUI/blob/main/flake.nix) * Good practices: documentation, tests, fuzzers, performance tests, automated CI, automated packaging, etc... ## Documentation - [Starter CMake](https://github.com/ArthurSonzogni/ftxui-starter) - [Starter Bazel](https://github.com/ArthurSonzogni/ftxui-bazel) - [Documentation](https://arthursonzogni.github.io/FTXUI/) - [Examples (WebAssembly)](https://arthursonzogni.github.io/FTXUI/examples/) - [Build using CMake](https://arthursonzogni.github.io/FTXUI/#build-cmake) - [Build using Bazel](https://arthursonzogni.github.io/FTXUI/#build-bazel) ## Example ~~~cpp vbox({ hbox({ text("one") | border, text("two") | border | flex, text("three") | border | flex, }), gauge(0.25) | color(Color::Red), gauge(0.50) | color(Color::White), gauge(0.75) | color(Color::Blue), }); ~~~  ## Short gallery #### DOM This module defines a hierarchical set of Element. An Element manages layout and can be responsive to the terminal dimensions. They are declared in [<ftxui/dom/elements.hpp>](https://arthursonzogni.github.io/FTXUI/elements_8hpp_source.html ) <details><summary>Layout</summary> Element can be arranged together: - horizontally with `hbox` - vertically with `vbox` - inside a grid with `gridbox` - wrap along one direction using the `flexbox`. Element can become flexible using the `flex` decorator. [Example](https://arthursonzogni.github.io/FTXUI/examples_2dom_2vbox_hbox_8cpp-example.html) using `hbox`, `vbox` and `filler`.  [Example](https://arthursonzogni.github.io/FTXUI/examples_2dom_2gridbox_8cpp-example.html) using gridbox:  [Example](https://github.com/ArthurSonzogni/FTXUI/blob/master/examples/dom/hflow.cpp) using flexbox:  [See](https://arthursonzogni.github.io/FTXUI/examples_2dom_2hflow_8cpp-example.html) also this [demo](https://arthursonzogni.github.io/FTXUI/examples/?file=component/flexbox). </details> <details><summary>Style</summary> An element can be decorated using the functions: - `bold` - `italic` - `dim` - `inverted` - `underlined` - `underlinedDouble` - `blink` - `strikethrough` - `color` - `bgcolor` - `hyperlink` [Example](https://arthursonzogni.github.io/FTXUI/examples_2dom_2style_gallery_8cpp-example.html)  FTXUI supports the pipe operator. It means: `decorator1(decorator2(element))` and `element | decorator1 | decorator2` can be used. </details> <details><summary>Colors</summary> FTXUI support every color palette: Color [gallery](https://arthursonzogni.github.io/FTXUI/examples_2dom_2color_gallery_8cpp-example.html):  </details> <details><summary>Border and separator</summary> Use decorator border and element separator() to subdivide your UI: ```cpp auto document = vbox({ text("top"), separator(), text("bottom"), }) | border; ``` [Demo](https://arthursonzogni.github.io/FTXUI/examples_2dom_2separator_8cpp-example.html):  </details> <details><summary>Text and paragraph</summary> A simple piece of text is represented using `text("content")`. To support text wrapping following spaces the following functions are provided: ```cpp Element paragraph(std::string text); Element paragraphAlignLeft(std::string text); Element paragraphAlignRight(std::string text); Element paragraphAlignCenter(std::string text); Element paragraphAlignJustify(std::string text); ``` [Paragraph example](https://arthursonzogni.github.io/FTXUI/examples_2dom_2paragraph_8cpp-example.html)  </details> <details><summary>Table</summary> A class to easily style a table of data. [Example](https://arthursonzogni.github.io/FTXUI/examples_2dom_2table_8cpp-example.html):  </details> <details><summary>Canvas</summary> Drawing can be made on a Canvas, using braille, block, or simple characters: Simple [example](https://github.com/ArthurSonzogni/FTXUI/blob/master/examples/dom/canvas.cpp):  Complex [examples](https://github.com/ArthurSonzogni/FTXUI/blob/master/examples/component/canvas_animated.cpp):  </details> #### Component ftxui/component produces dynamic UI, reactive to the user's input. It defines a set of ftxui::Component. A component reacts to Events (keyboard, mouse, resize, ...) and Renders as an Element (see previous section). Prebuilt components are declared in [<ftxui/component/component.hpp>](https://arthursonzogni.github.io/FTXUI/component_8hpp_source.html) <details><summary>Gallery</summary> [Gallery](https://arthursonzogni.github.io/FTXUI/examples_2component_2gallery_8cpp-example.html) of multiple components. ([demo](https://arthursonzogni.github.io/FTXUI/examples/?file=component/gallery))  </details> <details><summary>Radiobox</summary> [Example](https://arthursonzogni.github.io/FTXUI/examples_2component_2radiobox_8cpp-example.html):  </details> <details><summary>Checkbox</summary> [Example](https://arthursonzogni.github.io/FTXUI/examples_2component_2checkbox_8cpp-example.html):  </details> <details><summary>Input</summary> [Example](https://arthursonzogni.github.io/FTXUI/examples_2component_2input_8cpp-example.html):  </details> <details><summary>Toggle</summary> [Example](https://arthursonzogni.github.io/FTXUI/examples_2component_2toggle_8cpp-example.html):  </details> <details><summary>Slider</summary> [Example](https://arthursonzogni.github.io/FTXUI/examples_2component_2slider_8cpp-example.html):  </details> <details><summary>Menu</summary> [Example](https://arthursonzogni.github.io/FTXUI/examples_2component_2menu_8cpp-example.html):  </details> <details><summary>ResizableSplit</summary> [Example](https://arthursonzogni.github.io/FTXUI/examples_2component_2resizable_split_8cpp-example.html):  </details> <details><summary>Dropdown</summary> [Example](https://arthursonzogni.github.io/FTXUI/examples_2component_2dropdown_8cpp-example.html):  </details> <details><summary>Tab</summary> [Vertical](https://arthursonzogni.github.io/FTXUI/examples_2component_2tab_vertical_8cpp-example.html):  [Horizontal](https://arthursonzogni.github.io/FTXUI/examples_2component_2tab_horizontal_8cpp-example.html):  </details> ## Libraries for FTXUI - *Want to share a useful Component for FTXUI? Feel free to add yours here* - [ftxui-grid-container](https://github.com/mingsheng13/grid-container-ftxui) - [ftxui-ip-input](https://github.com/mingsheng13/ip-input-ftxui) - [ftxui-image-view](https://github.com/ljrrjl/ftxui-image-view.git): For Image Display. ## Project using FTXUI Feel free to add your projects here: - [json-tui](https://github.com/ArthurSonzogni/json-tui) - [git-tui](https://github.com/ArthurSonzogni/git-tui) - [rgb-tui](https://github.com/ArthurSonzogni/rgb-tui) - [chrome-log-beautifier](https://github.com/ArthurSonzogni/chrome-log-beautifier) --- - [2048-cpp](https://github.com/Chessom/2048-cpp) - [BestEdrOfTheMarket](https://github.com/Xacone/BestEdrOfTheMarket) - [Captain's log](https://github.com/nikoladucak/caps-log) - [Caravan](https://github.com/r3w0p/caravan) - [CryptoCalculator](https://github.com/brevis/CryptoCalculator) - [FTB - tertminal file browser](https://github.com/Cyxuan0311/FTB) - [FTowerX](https://github.com/MhmRhm/FTowerX) - [Fallout terminal hacking](https://github.com/gshigin/yet-another-fallout-terminal-hacking-game) - [Lazylist](https://github.com/zhuyongqi9/lazylist) - [Memory game](https://github.com/mikolajlubiak/memory) - [Path Finder](https://github.com/Ruebled/Path_Finder) - [Pigeon ROS TUI](https://github.com/PigeonSensei/Pigeon_ros_tui) - [SHOOT!](https://github.com/ShingZhanho/ENGG1340-Project-25Spring) - [StartUp](https://github.com/StubbornVegeta/StartUp) - [Step-Writer](https://github.com/BrianAnakPintar/step-writer) - [TUISIC](https://github.com/Dark-Kernel/tuisic) - [Terminal Animation](https://github.com/mikolajlubiak/terminal_animation) - [TimeAccumulator](https://github.com/asari555/TimeAccumulator) - [UDP chat](https://github.com/Sergeydigl3/udp-chat-tui) - [VerifySN (Fast Hash Tool)](https://github.com/d06i/verifySN) - [XJ music](https://github.com/xjmusic/xjmusic) - [beagle-config](https://github.com/SAtacker/beagle-config) - [cachyos-cli-installer](https://github.com/cachyos/new-cli-installer) - [eCAL monitor](https://github.com/eclipse-ecal/ecal) - [ftxuiFileReader](https://github.com/J0sephDavis/ftxuiFileReader) - [ftxui_CPUMeter](https://github.com/tzzzzzzzx/ftxui_CPUMeter) - [hastur](https://github.com/robinlinden/hastur) - [i3-termdialogs](https://github.com/mibli/i3-termdialogs) - [inLimbo](https://github.com/nots1dd/inLimbo) - [keywords](https://github.com/Oakamoore/keywords) ([Play web version :heart:](https://oakamoore.itch.io/keywords)) - [ltuiny](https://github.com/adrianoviana87/ltuiny) - [openJuice](https://github.com/mikomikotaishi/openJuice) - [ostree-tui](https://github.com/AP-Sensing/ostree-tui) - [pciex](https://github.com/s0nx/pciex) - [resource-monitor](https://github.com/catalincd/resource-monitor) - [rw-tui](https://github.com/LeeKyuHyuk/rw-tui) - [simpPRU](https://github.com/VedantParanjape/simpPRU) - [tabdeeli](https://github.com/typon/tabdeeli) - [terminal-rain](https://github.com/Oakamoore/terminal-rain) - [tic-tac-toe](https://github.com/birland/tic-tac-toe) - [tiles](https://github.com/tusharpm/tiles) - [todoman](https://github.com/aaleino/todoman) - [turing_cmd](https://github.com/DanArmor/turing_cmd) - [typing-speed-test](https://github.com/ymcx/typing-speed-test) - [vantage](https://github.com/gokulmaxi/vantage) - [x86-64 CPU Architecture Simulation](https://github.com/AnisBdz/CPU) ### [cpp-best-practices/game_jam](https://github.com/cpp-best-practices/game_jam) Several games using the FTXUI have been made during the Game Jam: - [TermBreaker](https://github.com/ArthurSonzogni/termBreaker) [**[Play web version]**](https://arthursonzogni.com/TermBreaker/) - [Minesweeper Marathon](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/minesweeper_marathon.md) [**[Play web version]**](https://barlasgarden.com/minesweeper/index.html) - [Grand Rounds](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/grandrounds.md) - [LightsRound](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/LightsRound.v.0.1.0.md) - [DanteO](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/danteo.md) - [Sumo](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/sumo.md) - [Drag Me aROUND](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/drag_me_around.md) - [DisarmSelfDestruct](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/DisarmSelfDestruct.md) - [TheWorld](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/TheWorld.md) - [smoothlife](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/smoothlife.md) - [Consu](https://github.com/cpp-best-practices/game_jam/blob/main/Jam1_April_2022/consu.md) ## Build using CMake It is **highly** recommended to use CMake FetchContent to depend on FTXUI so you may specify which commit you would like to depend on. ```cmake include(FetchContent) FetchContent_Declare(ftxui GIT_REPOSITORY https://github.com/ArthurSonzogni/ftxui GIT_TAG v6.1.9 ) FetchContent_MakeAvailable(ftxui) target_link_libraries(your_target PRIVATE # Chose a submodule ftxui::component ftxui::dom ftxui::screen ) ``` # Build using Bazel **MODULE.bazel** ```starlark bazel_dep( name = "ftxui", version = "v6.1.9", ) ``` **BUILD.bazel** ```starlark cc_binary( name = "your_target", srcs = ["your_source.cc"], deps = [ # Choose submodules "@ftxui//:component", "@ftxui//:dom", "@ftxui//:screen", # Or use the single ftxui target (includes all modules) # "@ftxui//:ftxui", ], ) ``` # Build with something else: If you don't, FTXUI may be used from the following packages: - CMake [FetchContent]([https://bewagner.net/programming/2020/05/02/cmake-fetchcontent/](https://cmake.org/cmake/help/latest/module/FetchContent.html)) (preferred), - [Bazel](https://registry.bazel.build/modules/ftxui), - [vcpkg](https://vcpkg.link/ports/ftxui), - [Conan](https://conan.io/center/recipes/ftxui) - [Debian package](https://tracker.debian.org/pkg/ftxui), - [Ubuntu package](https://launchpad.net/ubuntu/+source/ftxui), - [Arch Linux](https://aur.archlinux.org/packages/ftxui/), - [OpenSUSE](https://build.opensuse.org/package/show/devel:libraries:c_c++/ftxui), - [Nix](https://github.com/ArthurSonzogni/FTXUI/blob/main/flake.nix), [](https://repology.org/project/libftxui/versions) If you choose to build and link FTXUI yourself, `ftxui-component` must be first in the linking order relative to the other FTXUI libraries, i.e. ```bash g++ . . . -lftxui-component -lftxui-dom -lftxui-screen . . . ``` To build FTXUI with modules, check [documentation](https://arthursonzogni.github.io/FTXUI/cpp20-modules.html) ## Contributors <a href="https://github.com/ArthurSonzogni/FTXUI/graphs/contributors"> <img src="https://contrib.rocks/image?repo=ArthurSonzogni/FTXUI" /> </a> ", Assign "at most 3 tags" to the expected json: {"id":"2299","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"