No description
Find a file
Florian Dehau 13e194cd26 refactor: update widgets
* all widgets use the consumable builder pattern
* `draw` on terminal expect a closure that take a frame as only arg
2018-09-04 22:23:44 +02:00
docs Add examples and demo 2016-11-08 00:35:46 +01:00
examples refactor: update widgets 2018-09-04 22:23:44 +02:00
scripts refactor: clippy + rustfmt 2018-09-04 22:23:44 +02:00
src refactor: update widgets 2018-09-04 22:23:44 +02:00
.gitignore Update dependencies 2017-05-21 14:01:53 +02:00
.travis.yml travis: check style on stable only 2018-05-06 15:54:47 +02:00
Cargo.toml refactor: update widgets 2018-09-04 22:23:44 +02:00
CHANGELOG.md Release v0.2.3 2018-06-09 11:49:44 +02:00
LICENSE Add README, LICENSE and update demo 2016-11-07 01:07:53 +01:00
Makefile refactor: clippy + rustfmt 2018-09-04 22:23:44 +02:00
README.md chore(README): Add link to third-party widgets and other crates 2018-06-09 11:32:49 +02: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

Demo

The source code of the demo gif.

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.

Third-party widgets

Alternatives

You might want to checkout Cursive for an alternative solution to build text user interfaces in Rust.

License

MIT