rust terminal interfaces tui
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Florian Dehau ce445a8096 chore: remove scripts 6 years ago
assets chore: remove scripts 6 years ago
examples Unify Item and Text 6 years ago
src Unify Item and Text 6 years ago
.gitignore Update dependencies 7 years ago
.travis.yml travis: check style on stable only 6 years ago
CHANGELOG.md Release v0.3.0-beta.1 6 years ago
Cargo.toml Release v0.3.0-beta.1 6 years ago
LICENSE Add README, LICENSE and update demo 8 years ago
Makefile chore: remove scripts 6 years ago
README.md chore(README): Add link to third-party widgets and other crates 6 years ago

README.md

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