Widgetui

Turn

Ratatui Minimal

```rust fn main() -> Result<(), Box> { let mut terminal = setupterminal()?; run(&mut terminal)?; restoreterminal(&mut terminal)?; Ok(()) }

fn setupterminal() -> Result>, Box> { let mut stdout = io::stdout(); enableraw_mode()?; execute!(stdout, EnterAlternateScreen)?; Ok(Terminal::new(CrosstermBackend::new(stdout))?) }

fn restoreterminal( terminal: &mut Terminal>, ) -> Result<(), Box> { disablerawmode()?; execute!(terminal.backendmut(), LeaveAlternateScreen,)?; Ok(terminal.show_cursor()?) }

fn run(terminal: &mut Terminal>) -> Result<(), Box> { Ok(loop { terminal.draw(|frame| { let greeting = Paragraph::new("Hello World!"); frame.renderwidget(greeting, frame.size()); })?; if event::poll(Duration::frommillis(250))? { if let Event::Key(key) = event::read()? { if KeyCode::Char('q') == key.code { break; } } } }) } ```

Into

Much Better

```rust use ratatui::widgets::Paragraph;

use widgetui::*;

use std::{cell::RefMut, error::Error};

fn widget(frame: &mut WidgetFrame, mut events: RefMut) -> WidgetResult { frame.render_widget(Paragraph::new("Hello, world!", frame.size()));

if events.key(crossterm::event::KeyCode::Char('q')) {
    events.register_exit();
}

Ok(())

}

fn main() -> Result<(), Box> { App::new(100)?.with_widget(widget).run() } ```

The goal of this project is to simplify the requirements to make a good project using tui. It removes boilerplate, and improves the developer experience by using the power of typemaps, and dependency injection

Installation

Run the following within your project directory bash cargo add widgetui cargo add ratatui cargo add crossterm

Introduction

Widgetui is a wrapper over Ratatui's Crossterm backend which allows for powerful abstraction, and simplifies creating a good app within Ratatui.

Why pick this over Ratatui?

Widgetui isn't meant to replace or undermine Ratatui. It is simply a wrapper. Without Ratatui, this crate would not exist, as well, you will still require Ratatui and Crossterm crates just to work with the apps.

TLDR; Don't, use both together to improve developer experience, and build your apps faster!

Quickstart

```rust use ratatui::widgets::Paragraph;

use widgetui::*;

use std::{cell::RefMut, error::Error};

fn widget(frame: &mut WidgetFrame, mut events: RefMut) -> WidgetResult { frame.render_widget(Paragraph::new("Hello, world!", frame.size()));

if events.key(crossterm::event::KeyCode::Char('q')) {
    events.register_exit();
}

Ok(())

}

fn main() -> Result<(), Box> { App::new(100)?.with_widget(widget).run() } ```

The above will create an application that will display an empty terminal window, then close once you press q.

This application, with many less lines, will render the same thing that Ratatui's Quickstart renders.

Documentation

Documentation can be found on docs.rs.

Fun Facts