swaits/dioxus
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update Rink and Dioxus-TUI readmes

Browse Source
This commit is contained in:
Evan Almloff committed 2023-03-14 17:31:21 -05:00
1 parent 8b5551e5d2
commit ed6d813a9c
2 files changed
+17 -33
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

packages/dioxus-tui/README.md
+9 -9
View File
@@ -1,5 +1,5 @@
<div align="center"> <div align="center">
<h1>Rink</h1> <h1>Dioxus TUI</h1>
<p> <p>
<strong>Beautiful terminal user interfaces in Rust with <a href="https://dioxuslabs.com/">Dioxus </a>.</strong> <strong>Beautiful terminal user interfaces in Rust with <a href="https://dioxuslabs.com/">Dioxus </a>.</strong>
</p> </p>
@@ -37,7 +37,6 @@
</a> </a>
</div> </div>
<br/> <br/>
Leverage React-like patterns, CSS, HTML, and Rust to build beautiful, portable, terminal user interfaces with Dioxus. 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. 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 ## Limitations
- **Subset of Html** - **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** - **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 ## 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. 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 ## Features
Rink features: Dioxus TUI features:
- [x] Flexbox-based layout system - [x] Flexbox-based layout system
- [ ] CSS selectors - [ ] CSS selectors
- [x] inline CSS support - [x] inline CSS support
- [x] Built-in focusing system - [x] Built-in focusing system
* [x] Widgets<sup>1</sup> * [x] Widgets<sup>1</sup>
* [ ] Support for events, hooks, and callbacks<sup>2</sup> * [ ] Support for events, hooks, and callbacks<sup>2</sup>
* [ ] Html tags<sup>3</sup> * [ ] Html tags<sup>3</sup>
<sup>1</sup> 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. <sup>1</sup> 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.
<sup>2</sup> Basic keyboard, mouse, and focus events are implemented. <sup>2</sup> Basic keyboard, mouse, and focus events are implemented.
<sup>3</sup> 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. <sup>3</sup> 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.
packages/rink/README.md
+8 -24
View File
@@ -34,22 +34,7 @@
<br/> <br/>
Leverage CSS, HTML, and Rust to build beautiful, portable, terminal user interfaces. 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)
```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!"
}
})
}
```
![demo app](examples/example.png) ![demo app](examples/example.png)
@@ -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. 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 ## 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!** **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 ## Features
@@ -81,10 +66,9 @@ Rink features:
- [x] inline CSS support - [x] inline CSS support
- [x] Built-in focusing system - [x] Built-in focusing system
* [x] Widgets<sup>1</sup> * [ ] Widgets
* [ ] Support for events, hooks, and callbacks<sup>2</sup> * [ ] Support for events, hooks, and callbacks<sup>1</sup>
* [ ] Html tags<sup>3</sup> * [ ] Html tags<sup>2</sup>
<sup>1</sup> 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. <sup>1</sup> Basic keyboard, mouse, and focus events are implemented.
<sup>2</sup> Basic keyboard, mouse, and focus events are implemented. <sup>2</sup> 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.
<sup>3</sup> 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.