tui-popup 0.7.4

A simple popup for ratatui
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

use std::fmt::Debug;

use derive_setters::Setters;
use ratatui_core::buffer::Buffer;
use ratatui_core::layout::Rect;
use ratatui_core::widgets::Widget;

use crate::KnownSize;

/// The `KnownSizeWrapper` struct wraps a widget and provides a fixed size for it.
///
/// This struct is used to wrap a widget and provide a fixed size for it. This is useful when you
/// want to use a widget that does not implement [`KnownSize`] as the body of a popup.
#[derive(Debug, Setters)]
pub struct KnownSizeWrapper<W> {
    #[setters(skip)]
    pub inner: W,
    pub width: usize,
    pub height: usize,
}

impl<W: Widget> Widget for KnownSizeWrapper<W> {
    fn render(self, area: Rect, buf: &mut Buffer) {
        self.inner.render(area, buf);
    }
}

impl<W> Widget for &KnownSizeWrapper<W>
where
    for<'a> &'a W: Widget,
{
    fn render(self, area: Rect, buf: &mut Buffer) {
        self.inner.render(area, buf);
    }
}

impl<W> KnownSize for KnownSizeWrapper<W> {
    fn width(&self) -> usize {
        self.width
    }

    fn height(&self) -> usize {
        self.height
    }
}

impl<W> KnownSize for &KnownSizeWrapper<W> {
    fn width(&self) -> usize {
        self.width
    }

    fn height(&self) -> usize {
        self.height
    }
}

impl<W> KnownSizeWrapper<W> {
    /// Create a new `KnownSizeWrapper` with the given widget and size.
    pub const fn new(inner: W, width: usize, height: usize) -> Self {
        Self {
            inner,
            width,
            height,
        }
    }
}
#[cfg(test)]
mod tests {
    use ratatui_core::buffer::Buffer;
    use ratatui_core::layout::Rect;
    use ratatui_core::widgets::Widget;

    use super::*;

    struct TestWidget;

    impl Widget for TestWidget {
        fn render(self, area: Rect, buf: &mut Buffer) {
            "Hello".render(area, buf);
        }
    }

    #[test]
    fn test_sized_wrapper_new() {
        let widget = TestWidget;
        let wrapper = KnownSizeWrapper::new(widget, 10, 20);
        assert_eq!(wrapper.width, 10);
        assert_eq!(wrapper.height, 20);
    }

    #[test]
    fn test_sized_wrapper_render() {
        let widget = TestWidget;
        let wrapper = KnownSizeWrapper::new(widget, 20, 5);
        let mut buffer = Buffer::empty(Rect::new(0, 0, 20, 5));
        wrapper.render(buffer.area, &mut buffer);
        let expected = Buffer::with_lines([
            "Hello               ",
            "                    ",
            "                    ",
            "                    ",
            "                    ",
        ]);
        assert_eq!(buffer, expected);
    }
}