Awesome
tui-realm-stdlib
<p align="center"> <img src="/docs/images/tui-realm.svg" width="256" alt="logo" height="256" /> </p> <p align="center">~ A tui-rs framework inspired by Elm and React ~</p> <p align="center"> <a href="https://github.com/veeso/tuirealm_derive" target="_blank">tui-realm derive</a> ยท <a href="https://github.com/veeso/tui-realm" target="_blank">tui-realm</a> ยท <a href="https://docs.rs/tui-realm-stdlib" target="_blank">Documentation</a> </p> <p align="center">Developed by <a href="https://veeso.github.io/" target="_blank">@veeso</a></p> <p align="center">Current version: 1.3.2 (05/03/2024)</p> <p align="center"> <a href="https://opensource.org/licenses/MIT" ><img src="https://img.shields.io/badge/License-MIT-teal.svg" alt="License-MIT" /></a> <a href="https://github.com/veeso/tui-realm-stdlib/stargazers" ><img src="https://img.shields.io/github/stars/veeso/tui-realm-stdlib.svg" alt="Repo stars" /></a> <a href="https://crates.io/crates/tui-realm-stdlib" ><img src="https://img.shields.io/crates/d/tui-realm-stdlib.svg" alt="Downloads counter" /></a> <a href="https://crates.io/crates/tui-realm-stdlib" ><img src="https://img.shields.io/crates/v/tui-realm-stdlib.svg" alt="Latest version" /></a> <a href="https://ko-fi.com/veeso"> <img src="https://img.shields.io/badge/donate-ko--fi-red" alt="Ko-fi" /></a> </p> <p align="center"> <a href="https://github.com/veeso/tui-realm-stdlib/actions" ><img src="https://github.com/veeso/tui-realm-stdlib/workflows/tui/badge.svg" alt="tui ci" /></a> <a href="https://github.com/veeso/tui-realm-stdlib/actions" ><img src="https://github.com/veeso/tui-realm-stdlib/workflows/ratatui/badge.svg" alt="ratatui ci" /></a> <a href="https://docs.rs/tui-realm-stdlib" ><img src="https://docs.rs/tui-realm-stdlib/badge.svg" alt="Docs" /></a> </p>About tui-realm-stdlib ๐
tui-realm-stdlib is the standard component library for tui-realm.
It provides several Mock Components for your tui-realm applications. Probably all the components you need are here ๐
Get started ๐
Add tui-realm to your Cargo.toml ๐ฆ
tui-realm-stdlib = "^1.3.0"
or if you're not using the default crossterm backend, specify another backend in the cargo entry:
tui-realm-stdlib = { version = "^1.3.0", default-features = false, features = [ "ratatui", "termion" ] }
Latest version of tui-realm-stdlib requires tui-realm 1.9.0 or higher
tuirealm = "^1.9.0"
Support the developer โ
If you like tui-realm and you're grateful for the work I've done, please consider a little donation ๐ฅณ
You can make a donation with one of these platforms:
Components ๐จ
All the components implemented in the standard library can be viewed in the components wiki.
Utilities
The standard components library also exports the utils
module, which provides these very handy functions:
- wrap_spans: Creates span lines from text spans, in order to wrap lines
- use_or_default_styles: use colors and modifiers of the text spans if not
Color::Reset
orModifiers::empty()
, otherwise use the properties defined theProps
. - get_block: creates the block for the widget. If focus is true, the colors are applied, otherwise
Color::Reset
.
Documentation ๐
The developer documentation can be found on Rust Docs at https://docs.rs/tui-realm-stdlib
Contributing and issues ๐ค๐ป
Contributions, bug reports, new features and questions are welcome! ๐ If you have any question or concern, or you want to suggest a new feature, or you want just want to improve tui-realm-stdlib, feel free to open an issue or a PR.
Please follow our contributing guidelines
Changelog โณ
View tui-realm's changelog HERE
License ๐
tui-realm-stdlib is licensed under the MIT license.
You can read the entire license HERE