mirror of
https://github.com/ArthurSonzogni/FTXUI.git
synced 2024-11-29 14:45:53 +08:00
ef0de8d873
[nxxm](https://nxxm.github.io)
53 lines
2.2 KiB
Markdown
53 lines
2.2 KiB
Markdown
# FTXUI
|
|
|
|
**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).
|
|
* No dependencies.
|
|
|
|
## 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
|
|
|
|
* With [CMake](https://cmake.org) : See [Instructions](./tutorial/build-with-cmake.md)
|
|
* With [nxxm](https://nxxm.github.io) :See [Instructions](./tutorial/build-with-nxxm.md)
|
|
|
|
## Tutorial
|
|
See [Tutorial](./tutorial/tutorial.md)
|
|
|
|
## Project using FTXUI
|
|
None! This is still a newborn project. Please add a link to your project here.
|
|
|
|
## Hosted on:
|
|
* [github](https://github.com/ArthurSonzogni/ftxui)
|
|
* [gitlab](https://gitlab.com/ArthurSonzogni/ftxui)
|
|
|