No description
Find a file
2018-01-30 22:16:41 +01:00
docs Add examples and demo 2016-11-08 00:35:46 +01:00
examples [examples] Clean user input example 2018-01-27 10:46:58 +01:00
scripts [scripts] Allow pipefail for convenience 2017-12-26 21:45:46 +01:00
src Export AlternateScreenBackend. 2018-01-30 22:16:41 +01:00
.gitignore Update dependencies 2017-05-21 14:01:53 +02:00
.travis.yml Refactor Makefile install rule 2017-05-21 12:49:12 +02:00
Cargo.toml [examples] Add user input example 2018-01-27 10:46:58 +01:00
CHANGELOG.md Update CHANGELOG 2018-01-30 22:16:41 +01:00
LICENSE Add README, LICENSE and update demo 2016-11-07 01:07:53 +01:00
Makefile [scripts] Update installation of dev tools 2017-12-26 21:45:46 +01:00
README.md [doc] Move "Get started" from README to src/lib.rs 2017-12-26 21:45:46 +01:00

tui-rs

Build Status Crate Status Docs Status

Demo cast under Linux Termite with Inconsolata font 12pt

tui-rs is a Rust library to build rich terminal user interfaces and dashboards. It is heavily inspired by the Javascript library blessed-contrib and the Go library termui.

The library itself supports two different backends to draw to the terminal. You can either choose from:

However, some features may only be available in one of the two.

The library is based on the principle of immediate rendering with intermediate buffers. This means that at each new frame you should build all widgets that are supposed to be part of the UI. While providing a great flexibility for rich and interactive UI, this may introduce overhead for highly dynamic content. So, the implementation try to minimize the number of ansi escapes sequences generated to draw the updated UI. In practice, given the speed of Rust the overhead rather comes from the terminal emulator than the library itself.

Moreover, the library does not provide any input handling nor any event system and you may rely on the previously cited libraries to achieve such features.

Documentation

Widgets

The library comes with the following list of widgets:

Click on each item to see the source of the example. Run the examples with with cargo (e.g. to run the demo cargo run --example demo), and quit by pressing q.

Demo

The source code of the demo gif.

License

MIT

Author

Florian Dehau