7 KiB
ratatui
An actively maintained tui-rs fork.
Install
[dependencies]
tui = { package = "ratatui" }
What is this fork?
This fork was created to continue maintenance on the original TUI project. The original maintainer had created an issue explaining how he couldn't find time to continue development, which led to us creating this fork.
With that in mind, we the community look forward to continuing the work started by Florian Dehau. 🚀
In order to organize ourselves, we currently use a discord server, feel free to join and come chat ! There are also plans to implement a matrix bridge in the near future. Discord is not a MUST to contribute, we follow a pretty standard github centered open source workflow keeping the most important conversations on github, open an issue or PR and it will be addressed. 😄
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
ratatui 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, ratatui requires rustc version 1.59.0 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 libraries, bootstrapping templates and widgets
- ansi-to-tui — Convert ansi colored text to
tui::text::Text - color-to-tui — Parse hex colors to
tui::style::Color - rust-tui-template — A template for bootstrapping a Rust TUI application with Tui-rs & crossterm
- simple-tui-rs — A simple example tui-rs app
- tui-builder — Batteries-included MVC framework for Tui-rs + Crossterm apps
- tui-clap — Use clap-rs together with Tui-rs
- tui-log — Example of how to use logging with Tui-rs
- tui-logger — Logger and Widget for Tui-rs
- tui-realm — Tui-rs framework to build stateful applications with a React/Elm inspired approach
- tui-realm-treeview — Treeview component for Tui-realm
- tui tree widget — Tree Widget for Tui-rs
- tui-windows — Tui-rs abstraction to handle multiple windows and their rendering
- 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.
- tui-input: TUI input library supporting multiple backends and tui-rs.
Apps
Check out the list of close to 40 apps using ratatui!
Alternatives
You might want to checkout Cursive for an alternative solution to build text user interfaces in Rust.
Acknowledgements
Special thanks to Pavel Fomchenkov for his work in designing an awesome logo for the ratatui project and tui-rs-revival organization.