No description
Find a file
Florian Dehau 23d5fbde56 refactor(examples): remove exit key from Events handler
The thread spawned by `Events` to listen for keyboard inputs had knowlegde of
the exit key to exit on its own when it was pressed. It is however a source of
confusion (#491) because the exit behavior is wired in both the event handler
and the input handling performed by the app. In addition, this is not needed as
the thread will exit anyway when the main thread finishes as it is already the
case for the "tick" thread. Therefore, this commit removes both the option to
configure the exit key in the `Events` handler and the option to temporarily
ignore it.
2021-06-16 17:07:59 +02:00
.github chore: improve contributing guidelines 2021-05-02 21:42:31 +02:00
assets chore: remove scripts 2018-09-09 08:53:37 +02:00
examples refactor(examples): remove exit key from Events handler 2021-06-16 17:07:59 +02:00
src feat(block): add option to center and right align the title (#462) 2021-05-22 16:55:24 +02:00
tests feat(block): add option to center and right align the title (#462) 2021-05-22 16:55:24 +02:00
.gitignore gitignore 2019-05-17 14:25:55 +02:00
Cargo.toml Release v0.15.0 2021-05-02 19:03:01 +02:00
CHANGELOG.md Release v0.15.0 2021-05-02 19:03:01 +02:00
CONTRIBUTING.md chore: improve contributing guidelines 2021-05-02 21:42:31 +02:00
LICENSE Add README, LICENSE and update demo 2016-11-07 01:07:53 +01:00
Makefile.toml chore: make run-examples available on all platforms (#429) 2020-12-13 15:29:31 +01:00
README.md Add xplr to the "apps using tui" list 2021-05-22 15:08:06 +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 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.

Rust version requirements

Since version 0.10.0, tui requires rustc version 1.44.0 or greater.

Documentation

Demo

The demo shown in the gif can be run with all available backends (examples/*_demo.rs files). For example to see the termion version one could run:

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

where tick-rate is the UI refresh rate in ms.

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

Beware that the termion_demo only works on Unix platforms. If you are a Windows user, you can see the same demo using the crossterm backend with the following command:

cargo run --example crossterm_demo --no-default-features --features="crossterm" --release -- --tick-rate 200

If the user interface contains glyphs that are not displayed correctly by your terminal, you may want to run the demo without those symbols:

cargo run --example crossterm_demo --no-default-features --features="crossterm" --release -- --tick-rate 200 --enhanced-graphics false

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

Apps using tui

Alternatives

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

License

MIT