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

//! Element: box — bordered panel.
//!
//! Thin wrapper over `ratatui::widgets::Block` that sources its border and
//! title colors from a palette, so swapping themes requires no edits here.
//!
//! (`boxed` because `box` is a reserved keyword. The spec and CLI name
//! remain "box".)

use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use ratatui::style::Style;
use ratatui::text::Line;
use ratatui::widgets::{Block, Borders, Widget};

use super::super::theme::Palette;

/// Bordered panel with an optional title.
///
/// ```no_run
/// use ono::elements::boxed::BoxFrame;
/// use ono::theme::Theme;
/// use ratatui::widgets::Widget;
/// # use ratatui::{buffer::Buffer, layout::Rect};
/// # let mut buf = Buffer::empty(Rect::new(0, 0, 40, 6));
/// # let area = buf.area;
///
/// let palette = Theme::Forest.palette();
/// BoxFrame::new(palette).title("metrics").render(area, &mut buf);
/// ```
pub struct BoxFrame<'a> {
    title: Option<&'a str>,
    borders: Borders,
    palette: &'a Palette,
}

impl<'a> BoxFrame<'a> {
    /// Construct a fully-bordered box with no title.
    pub fn new(palette: &'a Palette) -> Self {
        Self {
            title: None,
            borders: Borders::ALL,
            palette,
        }
    }

    /// Set the title rendered into the top border.
    pub fn title(mut self, title: &'a str) -> Self {
        self.title = Some(title);
        self
    }

    /// Restrict which sides render a border (default `Borders::ALL`).
    pub fn borders(mut self, borders: Borders) -> Self {
        self.borders = borders;
        self
    }
}

impl Widget for BoxFrame<'_> {
    fn render(self, area: Rect, buf: &mut Buffer) {
        let mut block = Block::default()
            .borders(self.borders)
            .border_style(Style::default().fg(self.palette.border));
        if let Some(title) = self.title {
            block = block.title(
                Line::from(title).style(Style::default().fg(self.palette.primary)),
            );
        }
        block.render(area, buf);
    }
}