Home

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: 2.0.1 (13/10/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?style=badge" 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/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 = "2"

or if you're not using the default crossterm backend, specify another backend in the cargo entry:

tui-realm-stdlib = { version = "2", default-features = false, features = [ "termion" ] }

Latest version of tui-realm-stdlib requires tui-realm >= 2.0 or higher

tuirealm = "2"

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:

ko-fi PayPal


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:


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