#tui #terminal #dashboard

tui

A library to build rich terminal user interfaces or dashboards

16 unstable releases (4 breaking)

✓ Uses Rust 2018 edition

new 0.5.1 Apr 14, 2019
0.5.0 Mar 10, 2019
0.4.0 Feb 3, 2019
0.3.0 Nov 4, 2018
0.1.1 Nov 28, 2016

#25 in Command-line interface

Download history 130/week @ 2018-12-30 78/week @ 2019-01-06 83/week @ 2019-01-13 71/week @ 2019-01-20 91/week @ 2019-01-27 314/week @ 2019-02-03 256/week @ 2019-02-10 108/week @ 2019-02-17 334/week @ 2019-02-24 186/week @ 2019-03-03 187/week @ 2019-03-10 140/week @ 2019-03-17 206/week @ 2019-03-24 166/week @ 2019-03-31 108/week @ 2019-04-07

753 downloads per month
Used in 10 crates

MIT license

331KB
11K SLoC

tui-rs

Build Status 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 four different backends to draw to the terminal. You can either choose from:

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

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 demo shown in the gif can be run with all available backends (exmples/*_demo.rs files). For example to see the termion version one could run:

cargo run --example termion_demo --release -- --tick-rate 200

The UI code is in examples/demo/ui.rs while the application state is in examples/demo/app.rs.

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.

You can run all examples by running make run-examples.

Third-party widgets

Alternatives

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

License

MIT

Dependencies

~1.5MB
~22K SLoC