ratkit 0.2.14

A comprehensive collection of reusable TUI components for ratatui including resizable splits, tree views, markdown rendering, toast notifications, dialogs, and terminal embedding
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
86

# Core Runtime

The ratkit core runtime provides the foundation for building TUI applications with event handling, layout management, and rendering coordination.

## Modules

- [Runner](./runner.md) - Main application runner
- [Layout Coordinator](./layout_coordinator.md) - Layout management and element coordination
- [Event System](./events.md) - Input event handling
- [Types](./types.md) - Core type definitions
- [Registry](./registry.md) - Element registration and lifecycle
- [Focus Management](./focus.md) - Focus handling and navigation
- [Mouse Router](./mouse_router.md) - Mouse event routing

## Re-exports

These types are exported from the crate root for convenience:

### Core Types

| Type | Description |
|------|-------------|
| `Runner` | Main application runner |
| `RunnerConfig` | Configuration for the runner |
| `RunnerAction` | Actions the runner can take |
| `RunnerEvent` | Events handled by the runner |
| `CoordinatorApp` | Trait for coordinator-based applications |
| `CoordinatorAction` | Actions the coordinator can take |
| `CoordinatorEvent` | Events handled by the coordinator |
| `LayoutCoordinator` | Manages layout and rendering |
| `Element` | Trait for UI elements |
| `ElementHandle` | Handle to a registered element |
| `ElementId` | Unique identifier for elements |
| `ElementMetadata` | Metadata for registered elements |
| `Visibility` | Element visibility state |

### Event Types

| Type | Description |
|------|-------------|
| `KeyboardEvent` | Keyboard input events |
| `MouseEvent` | Mouse input events |
| `ResizeEvent` | Terminal resize events |
| `TickEvent` | Timer tick events |

### Result Types

| Type | Description |
|------|-------------|
| `LayoutResult<T>` | Result type for layout operations |
| `LayoutError` | Error type for layout operations |

### Configuration Types

| Type | Description |
|------|-------------|
| `MouseRouterConfig` | Configuration for mouse event routing |
| `CoordinatorConfig` | Configuration for the coordinator |
| `RedrawSignal` | Signal for requesting redraws |

### Focus Types

| Type | Description |
|------|-------------|
| `FocusRequest` | Request to change focus |

## Quick Start

```rust
use ratkit::prelude::*;
use ratatui::Frame;

struct MyApp;

impl CoordinatorApp for MyApp {
    fn on_event(&mut self, _event: CoordinatorEvent) -> LayoutResult<CoordinatorAction> {
        Ok(CoordinatorAction::Continue)
    }

    fn on_draw(&mut self, _frame: &mut Frame) {}
}

fn main() -> std::io::Result<()> {
    run(MyApp, RunnerConfig::default())
}
```