eddacraft-tui 0.2.3

Shared Ratatui component library for the eddacraft product family
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

use animate::{Lerp, Once};
use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use ratatui::style::{Modifier, Style};
use ratatui::widgets::{Block, Widget};

#[cfg(feature = "big-text")]
#[cfg_attr(docsrs, doc(cfg(feature = "big-text")))]
pub mod big_banner;
pub mod confirm;
pub mod container;
pub mod data_table;
pub mod divider;
pub mod editor;
pub mod header;
pub mod help_bar;
#[cfg(feature = "image")]
#[cfg_attr(docsrs, doc(cfg(feature = "image")))]
pub mod image_pane;
pub mod log_panel;
pub mod modal;
pub mod overlay;
pub mod parallel_progress;
pub mod pretext;
pub mod progress_bar;
pub mod select;
pub mod spinner;
pub mod status_badge;
pub mod status_bar;
pub mod text_input;
pub mod toast;
pub mod tree;
pub mod wrappers;

/// Animated `f64` value that eases toward its target over [`ANIM_DURATION_MS`].
pub(crate) type AnimatedF64 = Once<f64, fn(f64) -> f64, fn(&f64, &f64, f64) -> f64>;

/// Animated `u8` value that eases toward its target over [`ANIM_DURATION_MS`].
pub(crate) type AnimatedU8 = Once<u8, fn(f64) -> f64, fn(&u8, &u8, f64) -> u8>;

/// Default animation duration shared by progress widgets (milliseconds).
pub(crate) const ANIM_DURATION_MS: f64 = 250.0;

pub(crate) fn animated_f64(initial: f64) -> AnimatedF64 {
    Once::new(
        initial,
        ANIM_DURATION_MS,
        animate::easing::quad_out as fn(f64) -> f64,
        <f64 as Lerp>::lerp as fn(&f64, &f64, f64) -> f64,
    )
}

pub(crate) fn animated_u8(initial: u8) -> AnimatedU8 {
    Once::new(
        initial,
        ANIM_DURATION_MS,
        animate::easing::quad_out as fn(f64) -> f64,
        <u8 as Lerp>::lerp as fn(&u8, &u8, f64) -> u8,
    )
}

/// Render an optional block with a border style, returning the inner area.
/// If no block is provided, returns the original area unchanged.
pub(crate) fn render_block(
    block: Option<&Block<'_>>,
    border_style: Style,
    area: Rect,
    buf: &mut Buffer,
) -> Rect {
    if let Some(block) = block {
        let styled = block.clone().border_style(border_style);
        let inner = styled.inner(area);
        styled.render(area, buf);
        inner
    } else {
        area
    }
}

/// Apply [`Modifier::DIM`] to every cell in the intersection of `area` and the
/// buffer. Shared by overlay scrim and the `Disableable` wrapper so dim
/// semantics stay in lockstep across the crate.
pub(crate) fn dim_buffer(area: Rect, buf: &mut Buffer) {
    let clipped = area.intersection(buf.area);
    for y in clipped.y..clipped.y.saturating_add(clipped.height) {
        for x in clipped.x..clipped.x.saturating_add(clipped.width) {
            buf[(x, y)].modifier.insert(Modifier::DIM);
        }
    }
}