FTXUI/README.md

# FTXUI

![Travis (.com)](https://img.shields.io/travis/com/arthursonzogni/FTXUI?logo=travis)
![GitHub issues](https://img.shields.io/github/issues-raw/arthursonzogni/FTXUI)
![GitHub](https://img.shields.io/github/license/arthursonzogni/FTXUI?color=black)
![GitHub contributors](https://img.shields.io/github/contributors/arthursonzogni/FTXUI?color=blue)

**Functional Terminal (X) User interface**

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


## Demo:
![Demo image](./examples/component/homescreen.gif)

## 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).
 * Support for [UTF8](https://en.wikipedia.org/wiki/UTF-8) and [fullwidth chars](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) (→ 测试)
 * No dependencies.
 * Cross platform:
   - Linux (main target)
   - Windows (experimental, thanks to mauve@)
   - Mac (never tested, but must WORK)

## Example:
~~~cpp
  vbox(
    hbox(
      text(L"left") | border,
      text(L"middle") | border | flex,
      text(L"right") | border
    ),
    gauge(0.5) | border
  )
~~~

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

## Build

* [CMake](https://cmake.org) →  [Instructions](./tutorial/build-with-cmake.md)
* [nxxm](https://nxxm.github.io) → [Instructions](./tutorial/build-with-nxxm.md)

## Tutorial
- [Starter cmake project](https://github.com/ArthurSonzogni/ftxui-starter)
- [Tutorial](./tutorial/tutorial.md)

## Project using FTXUI
None! This is still a newborn project. Feel free to add a link to your project
here.

## Hosted on:
 * [github](https://github.com/ArthurSonzogni/ftxui)
 * [gitlab](https://gitlab.com/ArthurSonzogni/ftxui)