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

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

/// A spacer widget used for layout spacing.
///
/// [`Spacer`] is useful for adding space between widgets in a
/// [`Layout`](crate::widgets::Layout) or any other widget. [`Spacer`] can also
/// be used for widgets to be empty, such as in the
/// [`BgGrad`](crate::widgets::BgGrad) widget, where by default it contains
/// [`Spacer`].
///
/// # Sizing
///
/// [`Spacer`] widget tries to be as small as possible. If you don't specify
/// the minimum size in the [`Layout`](crate::widgets::Layout) (or other widget
/// you use it in), its size will be zero.
///
/// # Example
///
/// In this example, there will be one line of space between the two texts.
///
/// ```rust
/// use termint::prelude::*;
///
/// let mut layout = Layout::<()>::vertical();
/// layout.push("Top Widget", Constraint::Min(0));
///
/// // Insert a spacer with fixed height of 1
/// layout.push(Spacer::new(), Constraint::Length(1));
///
/// layout.push("Bottom Widget", Constraint::Min(0));
/// ```
#[derive(Debug, Default)]
pub struct Spacer;

impl Spacer {
    /// Creates a new spacer widget.
    #[must_use]
    pub fn new() -> Self {
        Self {}
    }
}

impl<M: Clone + 'static> Widget<M> for Spacer {
    fn render(&self, _buffer: &mut Buffer, _l: &LayoutNode) {}

    fn height(&self, _size: &Vec2) -> usize {
        0
    }

    fn width(&self, _size: &Vec2) -> usize {
        0
    }
}

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

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