Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/TylerBloom/webatui
An integration between the Yew and Ratatui crates for making TUI-themed WASM webapps
https://github.com/TylerBloom/webatui
Last synced: 19 days ago
JSON representation
An integration between the Yew and Ratatui crates for making TUI-themed WASM webapps
- Host: GitHub
- URL: https://github.com/TylerBloom/webatui
- Owner: TylerBloom
- License: lgpl-2.1
- Created: 2024-01-13T18:31:58.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-09-30T17:44:20.000Z (2 months ago)
- Last Synced: 2024-11-08T01:41:08.841Z (about 1 month ago)
- Language: Rust
- Size: 83 KB
- Stars: 48
- Watchers: 2
- Forks: 2
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-ratatui - webatui - An integration between the Yew and Ratatui crates for making TUI-themed WASM webapps. (📦 Libraries / 🏗️ Frameworks)
- awesome-ccamel - TylerBloom/webatui - An integration between the Yew and Ratatui crates for making TUI-themed WASM webapps (Rust)
README
[](https://crates.io/crates/webatui)
[](https://docs.rs/webatui/)
[](https://codecov.io/gh/TylerBloom/webatui)
## About
Webatui is an integration between the [Yew](https://github.com/yewstack/yew) and [Ratatui](https://github.com/ratatui-org/ratatui) for building TUI-themed webapps.
As much as possible, webatui is built to be "plug and play".
That is, if you already have a TUI app that you want to display in the browser, you should be able to do so with minimal refactoring.
The crate was inspired by the creation of my blog, [The Avid Rustacean](https://avid-rustacean.shuttleapp.rs/).
A write up on how Yew and Ratatui are integrated can be found in the blog [inital post](https://avid-rustacean.shuttleapp.rs/blog/About-This-Blog).
What webatui does:
- Renders the text to HTML
- Supports Ratatui's index colors via [base16-palettes](https://github.com/TylerBloom/base16-palettes)
- Supports hyperlinks
- Supports mouse events (clicks)
- Supports automatic screen resizing
- Supports scrolling (on PC and mobile)
## Basic Usage
This crate has examples that you can use as a template for your own project.
To get a more complete understanding, I would recommend following the [Yew tutorial](https://yew.rs/docs/tutorial).
Once you have wrapped your head around that (or just gotten it to run), come back here.
For basic apps, add Ratatui and Webatui as dependencies.
Webatui handles nearly all of the Yew-related details, but your app will use ratatui to render the text.
See the hello world example to see how to turn your Yew hello world example into a Webatui hello world.
There are a few important details.
Webatui handrolls most of its own CSS; however, you must use a monospace font.
Pick a font that you like, but every example uses Adobe's Source Code Pro font.
Many monospace fonts will render well on PC but do not render in a strickly monospace fashion on mobile.
Take this into consideration when picking your font.
## Contributing
This project is licensed under LGPL-2.1.
You may use this crate as a dependency on a closed-source/properity codebase; however, if you improve up or derivate another library crate from this crate, please license that crate under the LGPL-2.1 or a strong GPL license.
If you discover a bug, would like a feature supported, or have some way of improving this crate, please feel free to open an issue or a PR.
## Future Plans
This crate was born from an abstraction that I needed for my blog.
As such, there are surely ways to improve upon it.
I will avoid needlessly adding breaking changes; however, they still many occur for improved ergonomics, effieceny, final binary size, and more.