Mirrors/dioxus
2
0
Fork 0
mirror of https://github.com/DioxusLabs/dioxus synced 2024-09-20 14:21:58 +00:00
Code Issues Projects Releases Packages Wiki Activity
dioxus/packages/rink
History
Jonathan Kelley 1dde044697
remove cx.render
2024-01-13 21:12:21 -08:00
..
.vscode Move dioxus-specifc code into dioxus-tui crate and rename core crate to Rink 2023-03-13 12:04:51 -05:00
examples fix dioxus-tui events 2023-09-06 12:51:02 -05:00
src remove cx.render 2024-01-13 21:12:21 -08:00
.gitignore Move dioxus-specifc code into dioxus-tui crate and rename core crate to Rink 2023-03-13 12:04:51 -05:00
Cargo.toml Merge branch 'master' into events-2 2024-01-04 19:02:00 -06:00
README.md update Rink and Dioxus-TUI readmes 2023-03-14 17:31:21 -05:00
test.html Move dioxus-specifc code into dioxus-tui crate and rename core crate to Rink 2023-03-13 12:04:51 -05:00

README.md

Rink

A beautiful terminal user interfaces library in Rust.


Leverage CSS, HTML, and Rust to build beautiful, portable, terminal user interfaces. Rink is the cross-framework library that powers Dioxus-TUI

demo app

Background

You can use Html-like semantics with inline styles, tree hierarchy, components, and more in your text-based user interface (TUI) application.

Rink is essentially a port of Ink but for Rust. Rink doesn't depend on Node.js or any other JavaScript runtime, so your binaries are portable and beautiful.

Limitations

  • Subset of Html Terminals can only render a subset of HTML. We support as much as we can.
  • Particular frontend design Terminals and browsers are and look different. Therefore, the same design might not be the best to cover both renderers.

Status

WARNING: Rink is currently under construction!

Rendering a Dom works fine, but the ecosystem of widgets is not ready yet. Additionally, some bugs in the flexbox implementation might be quirky at times.

Features

Rink features:

  • Flexbox-based layout system
  • CSS selectors
  • inline CSS support
  • Built-in focusing system
  • Widgets
  • Support for events, hooks, and callbacks1
  • Html tags2

1 Basic keyboard, mouse, and focus events are implemented. 2 Currently, most HTML tags don't translate into any meaning inside of Rink. So an input element won't mean anything nor does it have any additional functionality.