termint 0.8.1

Library for colored printing and Terminal User Interfaces
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

use crate::{
    buffer::Buffer,
    prelude::Vec2,
    widgets::{Element, LayoutNode, Widget},
};

/// A container widget that stacks its children on top of each other (z-axis).
///
/// [`Overlay`] is useful for creating layered interface, such as modals and
/// popups, or floating elements.
///
/// # Layout behavior
///
/// [`Overlay`] passes the full available area to every child. The first child
/// is rendered at the bottom, and each subsequent child is rendered on top of
/// the previous one.
///
/// # Example
/// ```rust
/// use termint::prelude::*;
///
/// # fn get_content() -> Element { Spacer::new().into() }
/// # fn get_modal() -> Element { Spacer::new().into() }
/// let overlay = Overlay::new(vec![
///     get_content(),
///     // Modal is rendered on top of the content
///     get_modal(),
/// ]);
/// ```
pub struct Overlay<M: 'static = ()> {
    children: Vec<Element<M>>,
}

impl<M> Overlay<M> {
    /// Creates a new [`Overlay`] from a list of children.
    ///
    /// The first widget will be at the bottom, and the last on top.
    ///
    /// The `children` can be any type convertible into an iterator of
    /// [`Element`]s.
    ///
    /// # Example
    ///
    /// ```rust
    /// use termint::prelude::*;
    ///
    /// let overlay = Overlay::<()>::new(vec![
    ///     "Bottom",
    ///     "Middle",
    ///     "Top",
    /// ]);
    /// ```
    #[must_use]
    pub fn new<I>(children: I) -> Self
    where
        I: IntoIterator,
        I::Item: Into<Element<M>>,
    {
        Self {
            children: children.into_iter().map(|i| i.into()).collect(),
        }
    }

    /// Creates an empty [`Overlay`] with no children.
    #[must_use]
    pub fn empty() -> Self {
        Self { children: vec![] }
    }

    /// Pushes a new widget onto the top of the [`Overlay`] stack.
    ///
    /// The given widget will be rendered last, covering previous widgets.
    ///
    /// The `child` can be any type convertible into [`Element`].
    pub fn push<W>(&mut self, child: W)
    where
        W: Into<Element<M>>,
    {
        self.children.push(child.into());
    }
}

impl<M: Clone + 'static> Widget<M> for Overlay<M> {
    fn render(&self, buffer: &mut Buffer, layout: &LayoutNode) {
        for (i, child) in self.children.iter().enumerate() {
            child.render(buffer, &layout.children[i]);
        }
    }

    fn height(&self, size: &Vec2) -> usize {
        self.children
            .iter()
            .map(|c| c.height(size))
            .max()
            .unwrap_or(0)
    }

    fn width(&self, size: &Vec2) -> usize {
        self.children
            .iter()
            .map(|c| c.width(size))
            .max()
            .unwrap_or(0)
    }

    fn children(&self) -> Vec<&Element<M>> {
        self.children.iter().collect()
    }
}

impl<M: Clone + 'static> From<Overlay<M>> for Element<M> {
    fn from(value: Overlay<M>) -> Self {
        Element::new(value)
    }
}

impl<M: Clone + 'static> From<Overlay<M>> for Box<dyn Widget<M>> {
    fn from(value: Overlay<M>) -> Self {
        Box::new(value)
    }
}