tui-realm-stdlib

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

tui-realm derive · tui-realm · Documentation

Developed by @veeso

Current version: 2.0.1 (13/10/2024)

---

• tui-realm-stdlib
  • About tui-realm-stdlib 👑
  • Get started 🏁
    • Add tui-realm to your Cargo.toml 🦀
  • Support the developer ☕
  • Components 🎨
    • Utilities
  • Documentation 📚
  • Contributing and issues 🤝🏻
  • Changelog ⏳
  • License 📃

---

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:

---

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