ratada 0.0.1

A ratatui widget toolkit: driver, modals, forms, pickers, theming
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85

# ratada

A reusable [ratatui](https://ratatui.rs) widget toolkit for Rust terminal apps.

`ratada` provides the generic building blocks for a TUI over `ratatui` and
`crossterm`: a terminal guard and event loop, modals, forms, text editing,
pickers, tables, trees, a fuzzy finder, a help overlay, footers and status
bars, plus a framework-agnostic theming layer (colors, palette, glyphs and
layout mode) that maps onto ratatui styles.

## Overview

- **Driver** – a `Tui` RAII terminal guard (raw mode + alternate screen) and a
  generic `run` loop over a `Screen` trait.
- **Widgets** – modals (`confirm`, `select`, `multi_select`, `number_input`,
  `message`), forms, single- and multi-line text editing with a shared editor
  core, autocomplete, tables, trees, tabs, pagers, gauges, spinners, toasts.
- **Pickers** – color, date, date-range, month and path pickers.
- **Theming** – a `Skin` bundling a `Palette` (semantic colors), `Glyphs`
  (Unicode/ASCII variants) and a layout `Mode`; framework-agnostic so a CLI can
  share it, with a single ratatui adapter in `style`.

## Usage

```toml
[dependencies]
ratada = "0.0.1"
```

Implement the `Screen` trait and hand it to `run`, which owns the draw/input
loop inside a raw-mode `Tui` guard. The `prelude` re-exports the driver
essentials:

```rust,no_run
use ratada::prelude::*;
use ratatui::{Frame, text::Line};
use crossterm::event::{KeyCode, KeyEvent};

struct App {
    count: u32,
}

impl Screen for App {
    type Error = std::io::Error;

    fn render(&self, frame: &mut Frame) {
        frame.render_widget(
            Line::from(format!("count: {}  (space +1, q quit)", self.count)),
            frame.area(),
        );
    }

    fn handle_key(&mut self, key: KeyEvent, _tui: &mut Tui) -> std::io::Result<Flow> {
        match key.code {
            KeyCode::Char('q') => Ok(Flow::Quit),
            KeyCode::Char(' ') => {
                self.count += 1;
                Ok(Flow::Continue)
            }
            _ => Ok(Flow::Continue),
        }
    }
}

fn main() -> std::io::Result<()> {
    let mut tui = Tui::new()?;
    run(&mut tui, &mut App { count: 0 })
}
```

Widgets that support the opt-in boxed style take a `BoxDecor` (caption in the
top border, an automatic or fixed badge bottom-right), e.g.
`InputField::new("").max_len(40).boxed(BoxDecor::new().caption("Name"))`.

## Documentation

- [`API.md`](API.md) — a compact index of the public surface (rustdoc via
  `cargo doc --open` is the authoritative reference).
- [`DEVELOPMENT.md`](DEVELOPMENT.md) — module layout, conventions and how to add
  a widget.
- [`CLAUDE.md`](CLAUDE.md) — the binding style guide.

## License

MIT