tui-spinner 0.2.3

Customizable animated spinner widgets for Ratatui — braille arcs, bouncing bars, rotating glyphs, and symbol styles
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

// Shared internal macros for spinner widget boilerplate.
// Loaded via `#[macro_use] mod macros;` in lib.rs — available in every spinner module.

// ── impl Styled ───────────────────────────────────────────────────────────────

/// Implements `ratatui::style::Styled` for a spinner type.
///
/// Requires the type to have a `style: Style` field.
///
/// ```text
/// impl_styled_for!(BarSpinner<'_>);
/// ```
macro_rules! impl_styled_for {
    ($t:ty) => {
        impl ratatui::style::Styled for $t {
            type Item = Self;

            fn style(&self) -> ratatui::style::Style {
                self.style
            }

            fn set_style<S: Into<ratatui::style::Style>>(mut self, style: S) -> Self {
                self.style = style.into();
                self
            }
        }
    };
}

// ── impl Widget (owned → ref delegation) ─────────────────────────────────────

/// Implements `Widget for T` by delegating to `Widget for &T`.
///
/// Every spinner provides a `impl Widget for &T` that does the real work;
/// this generates the boilerplate `impl Widget for T` wrapper.
///
/// ```text
/// impl_widget_via_ref!(BarSpinner<'_>);
/// ```
macro_rules! impl_widget_via_ref {
    ($t:ty) => {
        impl ratatui::widgets::Widget for $t {
            fn render(self, area: ratatui::layout::Rect, buf: &mut ratatui::buffer::Buffer) {
                ratatui::widgets::Widget::render(&self, area, buf);
            }
        }
    };
}

// ── Standard widget render body ───────────────────────────────────────────────

/// Renders the standard spinner body inside `impl Widget for &T`.
///
/// 1. Early-exit on zero area.
/// 2. Apply the base style to the full area.
/// 3. Resolve the optional `Block` wrapper.
/// 4. Early-exit if the inner area is also zero.
/// 5. Render `$lines` via `Paragraph` with the widget's alignment.
///
/// ```text
/// impl Widget for &BarSpinner<'_> {
///     fn render(self, area: Rect, buf: &mut Buffer) {
///         render_spinner_body!(self, area, buf, self.build_lines(width));
///     }
/// }
/// ```
macro_rules! render_spinner_body {
    ($self:ident, $area:ident, $buf:ident, $lines:expr) => {{
        if $area.area() == 0 {
            return;
        }

        $buf.set_style($area, $self.style);

        let inner_area = $self.block.as_ref().map_or($area, |b| {
            let inner = b.inner($area);
            ratatui::widgets::Widget::render(b.clone(), $area, $buf);
            inner
        });

        if inner_area.area() == 0 {
            return;
        }

        ratatui::widgets::Paragraph::new($lines)
            .alignment($self.alignment)
            .render(inner_area, $buf);
    }};
}