Popularity
5.6
-
Activity
7.8
Declining
2
37
98

Monthly Downloads: 988
Programming language: Rust
License: MIT License
Tags: Terminal     Tui     Command-line     Dashboard    
Latest version: v0.6.2

tui-rs alternatives and similar packages

Based on the "TUI" category

Do you think we are missing an alternative of tui-rs or a related project?

Add another 'TUI' Package

README

tui-rs

Build Status Crate Status Docs Status

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](examples/demo/ui.rs) while the application state is in [examples/demo/app.rs](examples/demo/app.rs).

Widgets

The library comes with the following list of widgets:

  • [Block](examples/block.rs)
  • [Gauge](examples/gauge.rs)
  • [Sparkline](examples/sparkline.rs)
  • [Chart](examples/chart.rs)
  • [BarChart](examples/barchart.rs)
  • [List](examples/list.rs)
  • [Table](examples/table.rs)
  • [Paragraph](examples/paragraph.rs)
  • [Canvas (with line, point cloud, map)](examples/canvas.rs)
  • [Tabs](examples/tabs.rs)

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](LICENSE)


*Note that all licence references and agreements mentioned in the tui-rs README section above are relevant to that project's source code only.