#tui #terminal

tui-realm-stdlib

Standard components library for tui-realm

17 releases (stable)

1.3.1 Jan 6, 2024
1.3.0 Aug 22, 2023
1.2.0 Oct 17, 2022
1.1.6 Jan 30, 2022
0.5.0 Jul 31, 2021

#65 in Command line utilities

Download history 233/week @ 2023-11-05 274/week @ 2023-11-12 279/week @ 2023-11-19 281/week @ 2023-11-26 152/week @ 2023-12-03 195/week @ 2023-12-10 198/week @ 2023-12-17 218/week @ 2023-12-24 211/week @ 2023-12-31 271/week @ 2024-01-07 328/week @ 2024-01-14 339/week @ 2024-01-21 241/week @ 2024-01-28 255/week @ 2024-02-04 262/week @ 2024-02-11 485/week @ 2024-02-18

1,272 downloads per month
Used in 12 crates (10 directly)

MIT license

245KB
5.5K SLoC

tui-realm-stdlib

logo

~ A tui-rs framework inspired by Elm and React ~

tui-realm derive · tui-realm · Documentation

Developed by @veeso

Current version: 1.3.1 (06/01/2024)

License-MIT Repo stars Downloads counter Latest version Ko-fi

CI Docs



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:

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:

  • 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 or Modifiers::empty(), otherwise use the properties defined the Props.
  • 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

Dependencies

~3–14MB
~151K SLoC