Getting Started
Add the dependency
quadraui is published on crates.io
(latest 0.2.2) — add it with the backend feature(s) your app needs:
[dependencies]
quadraui = { version = "0.2", features = ["tui"] }
To track unreleased work instead, depend on the develop branch:
[dependencies]
quadraui = { git = "https://github.com/JDonaghy/quadraui", branch = "develop", features = ["tui"] }
The backend features:
| Feature | Backend |
|---|---|
tui | Terminal, via ratatui |
gtk | GTK4, via Cairo + Pango (needs libgtk-4-dev / pkg-config to build) |
macos | Core Graphics + Core Text (only compiles on target_os = "macos") |
win | Direct2D + DirectWrite |
Run the example
git clone https://github.com/JDonaghy/quadraui
cd quadraui
cargo run -p quadraui --example hello --features tui
Press any key to bump the counter; q to quit. Swap --features tui for
--features gtk (needs GTK4 installed) to run the exact same Hello app
as a native window instead.
Explore the gallery
cargo run -p quadraui-gallery --features tui
Every primitive this site’s Gallery documents lives in
quadraui-gallery/src/demos/ — one Demo implementation per primitive,
with a Code tab showing its own source and a Data tab showing the plain
JSON it renders.
Where to go next
- Gallery — every primitive, with its code sample and a backend-support grid.
- docs.rs — API reference for the published
release (or
cargo doc -p quadraui --features tui,gtk --openfrom a checkout for unreleased work). - crates.io — the published crate.
- GitHub repository — source,
issues, and
CLAUDE.md/CONTRIBUTING.mdfor contributing.