Beautiful terminal user interfaces in Rust with Dioxus .
@@ -37,7 +37,6 @@
-
Leverage React-like patterns, CSS, HTML, and Rust to build beautiful, portable, terminal user interfaces with Dioxus.
@@ -63,33 +62,34 @@ fn app(cx: Scope) -> Element {
You can use Html-like semantics with inline styles, tree hierarchy, components, and more in your [`text-based user interface (TUI)`](https://en.wikipedia.org/wiki/Text-based_user_interface) application.
-Rink is essentially a port of [Ink](https://github.com/vadimdemedes/ink) but for [`Rust`](https://www.rust-lang.org/) and [`Dioxus`](https://dioxuslabs.com/). Rink doesn't depend on Node.js or any other JavaScript runtime, so your binaries are portable and beautiful.
+Dioxus TUI is essentially a port of [Ink](https://github.com/vadimdemedes/ink) but for [`Rust`](https://www.rust-lang.org/) and [`Dioxus`](https://dioxuslabs.com/). Dioxus TUI 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.
+ 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.
-
+ 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!**
+**WARNING: Dioxus TUI 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:
+Dioxus TUI features:
+
- [x] Flexbox-based layout system
- [ ] CSS selectors
- [x] inline CSS support
- [x] Built-in focusing system
+
* [x] Widgets1
* [ ] Support for events, hooks, and callbacks2
* [ ] Html tags31 Currently only a subset of the input element is implemented as a component (not an element). The `Input` component supports sliders, text, numbers, passwords, buttons, and checkboxes.
2 Basic keyboard, mouse, and focus events are implemented.
-3 Currently, most HTML tags don't translate into any meaning inside of Dioxus TUI. So an `input` *element* won't mean anything nor does it have any additional functionality.
+3 Currently, most HTML tags don't translate into any meaning inside of Dioxus TUI. So an `input` _element_ won't mean anything nor does it have any additional functionality.
diff --git a/packages/rink/README.md b/packages/rink/README.md
index d021a728b..0c327db13 100644
--- a/packages/rink/README.md
+++ b/packages/rink/README.md
@@ -34,22 +34,7 @@
-Leverage CSS, HTML, and Rust to build beautiful, portable, terminal user interfaces.
-
-```rust
-fn app(cx: Scope) -> Element {
- cx.render(rsx!{
- div {
- width: "100%",
- height: "10px",
- background_color: "red",
- justify_content: "center",
- align_items: "center",
- "Hello world!"
- }
- })
-}
-```
+Leverage CSS, HTML, and Rust to build beautiful, portable, terminal user interfaces. Rink is the cross-framework library that powers [`Dioxus-TUI`](https://github.com/DioxusLabs/dioxus/tree/master/packages/dioxus-tui)
@@ -57,7 +42,7 @@ fn app(cx: Scope) -> Element {
You can use Html-like semantics with inline styles, tree hierarchy, components, and more in your [`text-based user interface (TUI)`](https://en.wikipedia.org/wiki/Text-based_user_interface) application.
-Rink is essentially a port of [Ink](https://github.com/vadimdemedes/ink) but for [`Rust`](https://www.rust-lang.org/) and [`Dioxus`](https://dioxuslabs.com/). Rink doesn't depend on Node.js or any other JavaScript runtime, so your binaries are portable and beautiful.
+Rink is essentially a port of [Ink](https://github.com/vadimdemedes/ink) but for [`Rust`](https://www.rust-lang.org/). Rink doesn't depend on Node.js or any other JavaScript runtime, so your binaries are portable and beautiful.
## Limitations
@@ -70,7 +55,7 @@ Rink is essentially a port of [Ink](https://github.com/vadimdemedes/ink) but for
**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.
+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
@@ -81,10 +66,9 @@ Rink features:
- [x] inline CSS support
- [x] Built-in focusing system
-* [x] Widgets1
-* [ ] Support for events, hooks, and callbacks2
-* [ ] Html tags3
+* [ ] Widgets
+* [ ] Support for events, hooks, and callbacks1
+* [ ] Html tags2
-1 Currently only a subset of the input element is implemented as a component (not an element). The `Input` component supports sliders, text, numbers, passwords, buttons, and checkboxes.
-2 Basic keyboard, mouse, and focus events are implemented.
-3 Currently, most HTML tags don't translate into any meaning inside of Dioxus TUI. So an `input` _element_ won't mean anything nor does it have any additional functionality.
+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.