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
//! Terminal text **reveal** animations.
//!
//! Two small primitives, both deliberately renderer-agnostic:
//!
//! - [`RevealHandle`] — typewriter that appears one grapheme at a time,
//! each grapheme fading from one [`Rgb`] to another over a configurable
//! window.
//! - [`PulseHandle`] — a single symbol that "breathes" between two
//! colors on a sinusoidal cycle.
//!
//! Both handles are **pure**: no I/O, no thread, no global clock. Every
//! time-bearing entry point takes an explicit [`std::time::Instant`] so
//! tests can step time deterministically and so the caller controls when
//! frames are emitted. You snapshot each animation once per redraw at
//! whatever cadence your renderer already runs (a TUI event loop, a
//! `crossterm` poll, etc.) and map the returned [`Rgb`] values to your
//! renderer's color type.
//!
//! # Example
//!
//! ```
//! use std::time::{Duration, Instant};
//! use jiwa::{RevealHandle, RevealOpts};
//!
//! let start = Instant::now();
//! let reveal = RevealHandle::start_at("Hello, 世界", RevealOpts::default(), start);
//!
//! // Render at any later instant — the caller chooses the cadence.
//! let frame = reveal.snapshot(start + Duration::from_millis(100));
//! for g in &frame {
//! // `g.text` is the grapheme cluster to draw, `g.color` is the
//! // RGB to draw it in, `g.progress` is the 0..=1 fade progress.
//! print!("{}", g.text);
//! }
//! ```
//!
//! # Why "jiwa"
//!
//! Japanese onomatopoeia for something appearing slowly, "じわじわ" —
//! the visual feel the typewriter+fade combination is going for.
//!
//! # Renderer mapping
//!
//! [`Rgb`] is intentionally not a wrapper around `crossterm::style::Color`
//! or `ratatui::style::Color` — pulling either in would force every
//! downstream caller to agree on the same renderer. Map at the call
//! site instead:
//!
//! ```ignore
//! use ratatui::style::Color;
//! let g = reveal.snapshot(now);
//! let color = Color::Rgb(g[0].color.0, g[0].color.1, g[0].color.2);
//! ```
pub use ;
pub use ;
pub use ;