crustkit 0.2.0

Small Ratatui and Crossterm primitives for terminal applications.
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
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

# Crustkit

Small reusable Rust TUI primitives for command-line applications built with
Ratatui and Crossterm.

Crustkit is intentionally not a full application framework. It provides terminal
lifecycle helpers, status lines, key hints, shell header/footer helpers, transfer
progress widgets, theme primitives, terminal background detection, small
adaptive layout helpers, and mouse-driven resizable sidebar state. With the
optional `taffy` feature, it also provides a thin bridge from Taffy layout trees
to Ratatui rectangles. App domain logic belongs in the consuming crate.

The crate is meant to stay composable and non-invasive: use the primitives you
need, keep your app state and domain workflow in your own crate, and rely on
Cargo patches for local iteration.

```toml
[dependencies]
crustkit = "0.1.0"
```

```rust
use std::time::Duration;

use crustkit::{AppTheme, ThemeMode};

let theme = AppTheme::detect_or(Duration::from_millis(100), ThemeMode::Dark);
```

CLI reload is opt-in:

```rust
let reload = crustkit::CliReload::enabled();
crustkit::run_reloadable_cli(reload, || app::run(root, reload))?;
```

The default enabled binding is `ctrl+r`.

TachyonFX support is enabled by default. Disable default features when a
consumer needs the smallest dependency graph:

```toml
[dependencies]
crustkit = { version = "0.1.0", default-features = false }
```

```rust
use crustkit::{
    ComponentEffect, ComponentEffectManager, ComponentEffectPattern, TextInput,
};

let mut effects = ComponentEffectManager::new();

terminal.draw(|frame| {
    let area = frame.area();
    let input = TextInput::new("Search", "Title:")
        .focused(true)
        .effect(
            ComponentEffect::dissolve(450)
                .pattern(ComponentEffectPattern::RadialCenter {
                    transition_width: 3.0,
                }),
        );

    effects.render_widget(
        frame,
        "search-input",
        area,
        input.clone().widget(),
        input.component_effect(),
    );
    effects.process_frame(frame, area);
})?;
```

The `effects` module also re-exports `tachyonfx`, so consumers can drop down to
raw `tachyonfx::fx::*` composition whenever the preset helpers are not enough.

Taffy support is opt-in:

```toml
[dependencies]
crustkit = { version = "0.1.0", features = ["taffy"] }
```

```rust
use crustkit::{TaffyTreeExt, taffy::prelude::*};

tree.compute_terminal_layout(root, frame.area())?;
let content = tree.layout_rect(content_node, frame.area())?;
```

Resizable sidebars are part of the base crate:

```rust
let split = sidebar.layout(area);
sidebar.handle_mouse(mouse, area);
```

The repository also includes a publish-disabled demo app:

```bash
cargo run -p crustkit-demo -- --help
cargo run -p crustkit-demo -- --no-effects
```