bc5a9e4c06
* doc: Updated readme and contributing guide with updates about the fork * doc: added missing discord invite link
7.3 KiB
tui-rs
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
- tui-logger
- tui-textarea: simple yet powerful multi-line text editor widget supporting several key shortcuts, undo/redo, text search, etc.
- tui-rs-tree-widgets: widget for tree data structures.
Apps using tui
- spotify-tui
- bandwhich
- kmon
- gpg-tui
- ytop
- zenith
- bottom
- oha
- gitui
- rust-sadari-cli
- desed
- diskonaut
- tickrs
- rusty-krab-manager
- termchat
- taskwarrior-tui
- gping
- Vector
- KDash
- xplr
- minesweep
- Battleship.rs
- termscp
- joshuto
- adsb_deku/radar
- hoard
- tokio-console: a diagnostics and debugging tool for asynchronous Rust programs.
- hwatch: a alternative watch command that records the result of command execution and can display its history and diffs.
- ytui-music: listen to music from youtube inside your terminal.
- mqttui: subscribe or publish to a MQTT Topic quickly from the terminal.
- meteo-tui: french weather via the command line.
- picterm: preview images in your terminal.
- gobang: a cross-platform TUI database management tool.
- oxker: a simple tui to view & control docker containers.
- trippy: a network diagnostic tool.
- cotp: a trustworthy, encrypted, command-line TOTP/HOTP authenticator app with import functionality.
- hg-tui: view hellogithub.com website on the terminal.
Alternatives
You might want to checkout Cursive for an alternative solution to build text user interfaces in Rust.