libshimmer 0.2.1

Animated status lines for terminal UIs, paced by the host's work
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

# libshimmer

Animated status lines for terminal UIs, paced by the host's work.

![The stock recipes, each painting its own name through a bout and the rest after it](media/roster.webp)

A host makes a `Shimmer` from one of the stock recipes, tells it what the host is doing and how hard it works, and each frame draws the status line it paints: a mark, the caption's letters, and a tail, over a backdrop of background colors. Paint is plain data; the `ratatui` feature converts it into ratatui 0.30 spans and shades a ratatui buffer. libshimmer reads no clock and keeps no global state: the host passes the time between frames, and paint depends only on the recipe, the seed, the commands so far, and the colors and motion the host paints with.

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

use libshimmer::{Glyphs, Intensity, Motion, Palette, Rgb, Shimmer, Spell, stock};

let recipe = stock::named("Lava Lamp").expect("a stock recipe");
let mut shimmer: Shimmer = Shimmer::new(recipe, 7, Glyphs::BASE)?;
shimmer.set_spell(Spell::Busy);
shimmer.show("Compiling");

// Each frame:
shimmer.set_intensity(Intensity::new(tokens_per_second / 100.0));
shimmer.advance(since_last_frame);
let palette = Palette { fg: Rgb(208.0, 208.0, 208.0), bg: Rgb(21.0, 21.0, 21.0) };
let row = shimmer.status(palette, Motion { mark: true, letters: true });
let spans = row.spans(); // with the `ratatui` feature; `row.cells()` otherwise
row.shade(area, buf);

// When the work ends:
shimmer.set_spell(Spell::Idle);
```

[SPEC.md](SPEC.md) specifies the design. MIT-0 licensed.