https://github.com/tui-rs-revival/ratatui Skip to content Toggle navigation Sign up * Product + Actions Automate any workflow + Packages Host and manage packages + Security Find and fix vulnerabilities + Codespaces Instant dev environments + Copilot Write better code with AI + Code review Manage code changes + Issues Plan and track work + Discussions Collaborate outside of code + Explore + All features + Documentation + GitHub Skills + Blog * Solutions + For + Enterprise + Teams + Startups + Education + By Solution + CI/CD & Automation + DevOps + DevSecOps + Case Studies + Customer Stories + Resources * Open Source + GitHub Sponsors Fund open source developers + The ReadME Project GitHub community articles + Repositories + Topics + Trending + Collections * Pricing [ ] * # In this repository All GitHub | Jump to | * No suggested jump to results * # In this repository All GitHub | Jump to | * # In this organization All GitHub | Jump to | * # In this repository All GitHub | Jump to | Sign in Sign up {{ message }} tui-rs-revival / ratatui Public * Notifications * Fork 12 * Star 267 tui-rs revival project github.com/fdehau/tui-rs/issues/654 License MIT license 267 stars 12 forks Star Notifications * Code * Issues 5 * Pull requests 28 * Discussions * Actions * Projects 1 * Security * Insights More * Code * Issues * Pull requests * Discussions * Actions * Projects * Security * Insights tui-rs-revival/ratatui This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository. main Switch branches/tags [ ] Branches Tags Could not load branches Nothing to show {{ refName }} default View all branches Could not load tags Nothing to show {{ refName }} default View all tags Name already in use A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch? Cancel Create 49 branches 36 tags Code * Local * Codespaces * Clone HTTPS GitHub CLI [https://github.com/t] Use Git or checkout with SVN using the web URL. [gh repo clone tui-rs] Work fast with our official CLI. Learn more. * Open with GitHub Desktop * Download ZIP Sign In Required Please sign in to use Codespaces. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching GitHub Desktop If nothing happens, download GitHub Desktop and try again. Launching Xcode If nothing happens, download Xcode and try again. Launching Visual Studio Code Your codespace will open once ready. There was a problem preparing your codespace, please try again. Latest commit @conradludgate conradludgate better safe shared layout cache (#62) ... 02573b0 Mar 12, 2023 better safe shared layout cache (#62) 02573b0 Git stats * 577 commits Files Permalink Failed to load latest commit information. Type Name Latest commit message Commit time .github fix(ci): Test MSRV compatibility on CI (#85) March 8, 2023 22:07 assets chore: remove scripts September 9, 2018 08:53 examples fix: Fix user_input example double key press registered on windows February 15, 2023 22:52 src better safe shared layout cache (#62) March 12, 2023 18:23 tests fix(widget)!: List should not ignore empty string items (#42) February 21, 2023 13:22 .gitignore gitignore May 17, 2019 14:25 CHANGELOG.md Release v0.19.0 August 14, 2022 15:38 CONTRIBUTING.md docs(contributing): specify the use of unsafe for optimization (#67) February 20, 2023 14:28 Cargo.toml docs: update to build more backends (#81) March 5, 2023 13:25 LICENSE Add README, LICENSE and update demo November 7, 2016 01:07 Makefile.toml chore(ci): re-enable clippy on CI (#59) February 16, 2023 18:51 README.md docs(readme): Add oxker to application list (#74) February 21, 2023 11:33 committed.toml chore: Integrate committed for checking conventional commits (#77) February 25, 2023 14:36 View code [ ] tui-rs What is this fork? Introduction Rust version requirements Documentation Demo Widgets Built in Third-party libraries, bootstrapping templates and widgets Apps using tui Alternatives License README.md 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 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. From here, we hope to continue developing the TUI 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: * crossterm [default] * termion 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.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: * Block * Gauge * Sparkline * Chart * BarChart * List * Table * Paragraph * Canvas (with line, point cloud, map) * Tabs 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 using tui * adsb_deku/radar -- Rust ADS-B decoder + TUI radar application * bandwhich -- Terminal utility for displaying current network utilization by process, connection and remote IP/hostname * battleship.rs -- A terminal battleship game in Rust * bottom -- Yet another cross-platform graphical process/system monitor * conclusive -- Command line client for Plausible Analytics * cotp -- Trustworthy, encrypted, command-line TOTP/HOTP authenticator app with import functionality * cube timer -- A tui-based Rubik's cube timer written in Rust * desed -- Debugger for Sed: demystify and debug your sed scripts, from comfort of your terminal * diskonaut -- Terminal disk space navigator * exhaust -- Exhaust all your possibilities.. for the next coming exam * game-of-life-rs -- Conway's Game of Life implemented in Rust and visualized with Tui-rs * gitui -- Blazing fast terminal-ui for Git written in Rust * gpg-tui -- Manage your GnuPG keys with ease! * gping -- Ping, but with a graph * joshuto -- Ranger-like terminal file manager written in Rust * kDash -- A simple and fast dashboard for Kubernetes * kmon -- Linux Kernel Manager and Activity Monitor * kubectl-watch -- A kubectl plugin to provide a pretty delta change view of being watched kubernetes resources * minesweep -- Sweep some mines for fun, and probably not for profit * oha -- HTTP load generator, inspired by rakyll/hey with tui animation * oxker -- a simple tui to view & control docker containers * poketex -- A simple pokedex based on TUI * rrtop -- Redis monitoring (top like) app * rust-sadari-cli -- Sadari game based on terminal * rusty-krab-manager -- Time-management TUI in Rust * spotify-tui -- Spotify for the terminal written in Rust * taskwarrior-tui -- A terminal user interface for Taskwarrior * termchat -- Terminal chat through the LAN with video streaming and file transfer * termscp -- A feature rich terminal UI file transfer and explorer with support for SCP/SFTP/FTP/S3 * tick-rs -- Realtime ticker data in your terminal * tsuchita -- Client-server notification center for dbus desktop notifications * tuinance -- Display financial data on the terminal * vector -- A lightweight, ultra-fast tool for building observability pipelines * xplr -- A hackable, minimal, fast TUI file explorer * ytop -- A TUI system monitor written in Rust (no longer maintained) * zenith -- Sort of like top or htop but with zoom-able charts, CPU, GPU, network, and disk usage Alternatives You might want to checkout Cursive for an alternative solution to build text user interfaces in Rust. License MIT About tui-rs revival project github.com/fdehau/tui-rs/issues/654 Resources Readme License MIT license Stars 267 stars Watchers 11 watching Forks 12 forks Releases 36 tags Packages 0 No packages published Contributors 107 * @fdehau * @karolinepauls * @orhun * @TimonPost * @rhysd * @abusch * @defiori * @sayanarijit * @dflemstr * @stevensonmt * @mindoodoo + 96 contributors Languages * Rust 100.0% Footer (c) 2023 GitHub, Inc. Footer navigation * Terms * Privacy * Security * Status * Docs * Contact GitHub * Pricing * API * Training * Blog * About You can't perform that action at this time. You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.