Skip to content

nullorder/ono

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Ono

Crates.io Docs.rs Lib.rs License: MIT MSRV Downloads Open Source

Beautiful terminal UI components for Ratatui. Themeable widgets you can use as a library or eject into your tree as plain source.

The shipped Rust crate lives at ono/ — see ono/README.md for install + usage, or crates.io/crates/ono.

Two ways to use it

  • Library (default) — add the crate, use ono::components::..., drive components with typed builders and a Theme.
  • Eject (power path) — ono add <name> copies the component's source into your tree, no runtime dependency on ono after that. Use it when you want to rewrite rendering beyond what builder params expose.

Model

  • Components — themeable widgets. Split into elements (atomic: progress, spinner, box, ...) and components (composite: splash, boot, dashboard, statusbar, ...).
  • Themes — palette of nine semantic roles + animation knobs. Ono ships four built-in themes (Forest, Retro, Minimal, Cyber); Forest is the default. Custom themes are just a Palette + Knobs you construct yourself.

Documentation

  • Getting started — five-minute walkthrough.
  • Theming — palette roles, knobs, custom themes.
  • Components — catalog with a snippet per widget.
  • Ejecting — when to use the eject path, and the tradeoffs.

API reference: docs.rs/ono.

Contributing

Bug reports, feature requests, and patches welcome. See CONTRIBUTING.md for dev setup and how new components graduate from the experiments scratchpad into the library.

License

MIT — NullOrder.

About

Beautiful terminal UI components for Ratatui 💻

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors