FTXUI/README.md

# FTXUI

**Functional Terminal (X) User interface**

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

![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)

## 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)
Update tutorial.md and readme.md 2019-01-06 08:37:26 +08:00			`# FTXUI`
Update README and tutorial. 2019-01-27 23:56:37 +08:00
			`Functional Terminal (X) User interface`
Update tutorial.md and readme.md 2019-01-06 08:37:26 +08:00
Add "Project using FTXUI" section. 2019-01-28 00:11:43 +08:00			`A simple C++ library for terminal based user interface.`
Update tutorial.md and readme.md 2019-01-06 08:37:26 +08:00
Update README.md 2020-04-10 20:27:53 +08:00			`![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)`
Update README.md 2020-03-27 08:20:06 +08:00
Update README and tutorial. 2019-01-27 23:56:37 +08:00			`## Demo:`
			`![Demo image](./examples/component/homescreen.gif)`

Update tutorial.md and readme.md 2019-01-06 08:37:26 +08:00			`## Feature`
Update Readme.md 2019-01-28 00:20:55 +08:00			`* Functional style. Inspired by`
📌 Update README.md 2019-06-30 01:05:22 +08:00			`[[1]](https://hackernoon.com/building-reactive-terminal-interfaces-in-c-d392ce34e649?gi=d9fb9ce35901)`
Update Readme.md 2019-01-28 00:20:55 +08:00			`and [React](https://reactjs.org/)`
Update tutorial.md and readme.md 2019-01-06 08:37:26 +08:00			`* Simple and elegant syntax (in my opinion).`
📌 Update README.md 2019-06-30 01:05:22 +08:00			`* Support for [UTF8](https://en.wikipedia.org/wiki/UTF-8) and [fullwidth chars](https://en.wikipedia.org/wiki/Halfwidth_and_fullwidth_forms) (→ 测试)`
Update tutorial.md and readme.md 2019-01-06 08:37:26 +08:00			`* No dependencies.`
Update Readme. Talk about Windows support. 2020-03-27 08:10:03 +08:00			`* Cross platform:`
			`- Linux (main target)`
			`- Windows (experimental, thanks to mauve@)`
			`- Mac (never tested, but must WORK)`
Update README.md 2019-01-19 05:45:25 +08:00
Update tutorial.md and readme.md 2019-01-06 08:37:26 +08:00			`## Example:`
			`~~~cpp`
			`vbox(`
			`hbox(`
Add "frame" : scrollable area. 2019-01-20 05:06:05 +08:00			`text(L"left") \| border,`
			`text(L"middle") \| border \| flex,`
			`text(L"right") \| border`
Update tutorial.md and readme.md 2019-01-06 08:37:26 +08:00			`),`
Add "frame" : scrollable area. 2019-01-20 05:06:05 +08:00			`gauge(0.5) \| border`
Update tutorial.md and readme.md 2019-01-06 08:37:26 +08:00			`)`
			`~~~`

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

Add support for nxxm. [nxxm](https://nxxm.github.io) 2019-02-02 08:59:48 +08:00			`## Build`

📌 Update README.md 2019-06-30 01:05:22 +08:00			`* [CMake](https://cmake.org) → [Instructions](./tutorial/build-with-cmake.md)`
			`* [nxxm](https://nxxm.github.io) → [Instructions](./tutorial/build-with-nxxm.md)`
Add support for nxxm. [nxxm](https://nxxm.github.io) 2019-02-02 08:59:48 +08:00
Update tutorial.md and readme.md 2019-01-06 08:37:26 +08:00			`## Tutorial`
Update README.md 2020-02-12 20:54:13 +08:00			`- [Starter cmake project](https://github.com/ArthurSonzogni/ftxui-starter)`
			`- [Tutorial](./tutorial/tutorial.md)`
Update tutorial.md and readme.md 2019-01-06 08:37:26 +08:00
Add "Project using FTXUI" section. 2019-01-28 00:11:43 +08:00			`## Project using FTXUI`
📌 Update README.md 2019-06-30 01:05:22 +08:00			`None! This is still a newborn project. Feel free to add a link to your project`
			`here.`
Add "Project using FTXUI" section. 2019-01-28 00:11:43 +08:00
Update Readme.md 2019-01-28 00:20:55 +08:00			`## Hosted on:`
			`* [github](https://github.com/ArthurSonzogni/ftxui)`
			`* [gitlab](https://gitlab.com/ArthurSonzogni/ftxui)`