dioxus/packages/tui
Demonthos 3b7b503333
Refactor Mutations and simplify Templates (#578)
* update mutations to be path based rather than renderer integrated
2022-10-18 14:42:45 -07:00
..
.vscode feat: add tui 2022-03-09 12:55:30 -05:00
benches Renderers are now packages, not features. (#387) 2022-07-09 15:15:20 -04:00
examples Refactor Mutations and simplify Templates (#578) 2022-10-18 14:42:45 -07:00
src Refactor Mutations and simplify Templates (#578) 2022-10-18 14:42:45 -07:00
tests Merge branch 'master' of https://github.com/DioxusLabs/dioxus into rusty-events 2022-06-29 02:18:57 +03:00
.gitignore feat: add tui 2022-03-09 12:55:30 -05:00
Cargo.toml replace fxhash crate with rustc-hash (#588) 2022-10-12 18:27:26 -07:00
README.md update readme 2022-05-03 18:43:28 -05:00
test.html feat: add tui 2022-03-09 12:55:30 -05:00

Rink

Beautiful terminal user interfaces in Rust with Dioxus .


Leverage React-like patterns, CSS, HTML, and Rust to build beautiful, portable, terminal user interfaces with Dioxus.

fn app(cx: Scope) -> Element {
    cx.render(rsx!{
        div {
            width: "100%",
            height: "10px",
            background_color: "red",
            justify_content: "center",
            align_items: "center",
            "Hello world!"
        }
    })
}

demo app

Background

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

Rink is basically a port of Ink but for Rust and Dioxus. 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 VirtualDom works fine, but the ecosystem of hooks is not yet ready. 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
  • high-quality keyboard support
  • Support for events, hooks, and callbacks1
  • Html tags2

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