ono 0.1.0

Beautiful terminal UI components for Ratatui — themeable widgets with an eject-to-source CLI.
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

//! Component: statusbar — one-line status bar.
//!
//! Matches `specs/components/statusbar.toml`. Composition anchor: wires
//! `spinner`, `progress`, and `percentage` elements together with typed
//! params. Self-contained — imports only ratatui, sibling elements, and
//! the local `Palette`.

use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use ratatui::style::Style;
use ratatui::text::Line;
use ratatui::widgets::Widget;

use super::super::elements::percentage::Percentage;
use super::super::elements::progress::{Progress, ProgressStyle};
use super::super::elements::spinner::Spinner;
use super::super::theme::Palette;

/// One-line status bar: label · spinner · progress · percentage.
///
/// Composes [`Spinner`], [`Progress`], and [`Percentage`] elements. Toggle
/// parts individually; the layout collapses around what's shown.
///
/// ```no_run
/// use ono::components::statusbar::Statusbar;
/// use ono::theme::Theme;
/// use ratatui::widgets::Widget;
/// # use ratatui::{buffer::Buffer, layout::Rect};
/// # let mut buf = Buffer::empty(Rect::new(0, 0, 80, 1));
/// # let area = buf.area;
///
/// let palette = Theme::Forest.palette();
/// Statusbar::new(palette)
///     .label("Compiling")
///     .percent(0.35)
///     .show_spinner(true)
///     .tick(12)
///     .render(area, &mut buf);
/// ```
pub struct Statusbar<'a> {
    label: &'a str,
    percent: f32,
    width: u16,
    show_spinner: bool,
    show_progress: bool,
    show_percent: bool,
    tick: u64,
    palette: &'a Palette,
}

impl<'a> Statusbar<'a> {
    /// Construct a status bar with defaults (label "Working", progress + percent
    /// shown, spinner hidden).
    pub fn new(palette: &'a Palette) -> Self {
        Self {
            label: "Working",
            percent: 0.0,
            width: 60,
            show_spinner: false,
            show_progress: true,
            show_percent: true,
            tick: 0,
            palette,
        }
    }

    /// Leading label text.
    pub fn label(mut self, label: &'a str) -> Self {
        self.label = label;
        self
    }

    /// Current progress (clamped to `0.0..=1.0`).
    pub fn percent(mut self, percent: f32) -> Self {
        self.percent = percent.clamp(0.0, 1.0);
        self
    }

    /// Total width in cells (minimum 10).
    pub fn width(mut self, width: u16) -> Self {
        self.width = width.max(10);
        self
    }

    /// Show an animated spinner between the label and the progress bar.
    pub fn show_spinner(mut self, show: bool) -> Self {
        self.show_spinner = show;
        self
    }

    /// Show the progress bar.
    pub fn show_progress(mut self, show: bool) -> Self {
        self.show_progress = show;
        self
    }

    /// Show the trailing `nn%` readout.
    pub fn show_percent(mut self, show: bool) -> Self {
        self.show_percent = show;
        self
    }

    /// Caller-owned tick for the spinner's frame counter.
    pub fn tick(mut self, tick: u64) -> Self {
        self.tick = tick;
        self
    }
}

impl Widget for Statusbar<'_> {
    fn render(self, area: Rect, buf: &mut Buffer) {
        if area.height == 0 || area.width == 0 {
            return;
        }
        let y = area.y;
        let max_x = area.x + area.width.min(self.width);
        let mut x = area.x;

        if !self.label.is_empty() && x < max_x {
            let w = (self.label.chars().count() as u16).min(max_x - x);
            Line::from(self.label)
                .style(Style::default().fg(self.palette.primary))
                .render(Rect { x, y, width: w, height: 1 }, buf);
            x = (x + w + 1).min(max_x);
        }

        if self.show_spinner && x < max_x {
            Spinner::new(self.palette)
                .tick(self.tick)
                .render(Rect { x, y, width: 1, height: 1 }, buf);
            x = (x + 2).min(max_x);
        }

        if self.show_progress && x < max_x {
            let desired = self.width.saturating_sub(20).max(1);
            let bar_w = desired.min(max_x - x);
            Progress::new(self.percent, self.palette)
                .width(bar_w)
                .style(ProgressStyle::Unicode)
                .render(Rect { x, y, width: bar_w, height: 1 }, buf);
            x = (x + bar_w + 1).min(max_x);
        }

        if self.show_percent && x < max_x {
            let w = 5u16.min(max_x - x);
            Percentage::new(self.percent, self.palette).render(
                Rect { x, y, width: w, height: 1 },
                buf,
            );
        }
    }
}