No description
Find a file
Leon Sautour bc5a9e4c06
doc: Updated readme and contributing guide with updates about the fork (#46)
* doc: Updated readme and contributing guide with updates about the fork

* doc: added missing discord invite link
2023-02-13 16:10:08 +01:00
.github chore(ci): bump cargo-make to v0.35.16 2022-08-14 14:43:38 +02:00
assets chore: remove scripts 2018-09-09 08:53:37 +02:00
examples chore: add panic hook example (#593) 2022-04-24 16:49:57 +02:00
src chore: fix typo in layout.rs (#619) 2022-08-14 15:58:02 +02:00
tests feat(widgets/chart): add option to control alignment of axis labels (#568) 2021-12-23 19:02:10 +01:00
.gitignore gitignore 2019-05-17 14:25:55 +02:00
Cargo.toml Release v0.19.0 2022-08-14 15:38:31 +02:00
CHANGELOG.md Release v0.19.0 2022-08-14 15:38:31 +02:00
CONTRIBUTING.md doc: Updated readme and contributing guide with updates about the fork (#46) 2023-02-13 16:10:08 +01:00
LICENSE Add README, LICENSE and update demo 2016-11-07 01:07:53 +01:00
Makefile.toml chore: enable clippy on all targets 2021-12-23 18:55:43 +01:00
README.md doc: Updated readme and contributing guide with updates about the fork (#46) 2023-02-13 16:10:08 +01:00

tui-rs

Build Status Crate Status Docs Status

Demo cast under Linux Termite with Inconsolata font 12pt

What is this fork

This fork was created after the original repository was no longer maintained. The original maintainer had created an issue to which he didn't reply leaving us with no choice but to create this fork in order to continue development on this crate.

In order to organize ourselves, we have created a temporary discord server. We have not yet determined with the community what will be our definitive communication medium.

Please make sure you read the updated contributing guidelines, especially if you are interested in working on a PR or issue opened in the previous repository.

Introduction

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 supports multiple backends:

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.17.0, tui requires rustc version 1.56.1 or greater.

Documentation

The documentation can be found on docs.rs.

Demo

The demo shown in the gif can be run with all available backends.

# crossterm
cargo run --example demo --release -- --tick-rate 200
# termion
cargo run --example demo --no-default-features --features=termion --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.

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 demo --release -- --tick-rate 200 --enhanced-graphics false

Widgets

Built in

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 gauge example cargo run --example gauge), and quit by pressing q.

You can run all examples by running cargo make run-examples (require cargo-make that can be installed with cargo install cargo-make).

Third-party

Apps using tui

Alternatives

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

License

MIT