rnk 0.15.31

A React-like declarative terminal UI framework for Rust, inspired by Ink
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
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173

//! Tooltip component for contextual information
//!
//! Displays tooltip text alongside content.
//!
//! # Example
//!
//! ```rust,ignore
//! use rnk::prelude::*;
//! use rnk::components::Tooltip;
//!
//! fn app() -> Element {
//!     Tooltip::new("Hover for info")
//!         .content("This is helpful information")
//!         .position(TooltipPosition::Right)
//!         .into_element()
//! }
//! ```

use crate::components::{Box as RnkBox, Text};
use crate::core::{Color, Element, FlexDirection};

/// Tooltip position
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default)]
pub enum TooltipPosition {
    Top,
    #[default]
    Right,
    Bottom,
    Left,
}

/// A tooltip component
#[derive(Debug, Clone)]
pub struct Tooltip {
    label: String,
    content: String,
    position: TooltipPosition,
    visible: bool,
}

impl Tooltip {
    /// Create a new tooltip
    pub fn new(label: impl Into<String>) -> Self {
        Self {
            label: label.into(),
            content: String::new(),
            position: TooltipPosition::Right,
            visible: true,
        }
    }

    /// Set the tooltip content
    pub fn content(mut self, content: impl Into<String>) -> Self {
        self.content = content.into();
        self
    }

    /// Set the tooltip position
    pub fn position(mut self, position: TooltipPosition) -> Self {
        self.position = position;
        self
    }

    /// Set visibility
    pub fn visible(mut self, visible: bool) -> Self {
        self.visible = visible;
        self
    }

    /// Convert to Element
    pub fn into_element(self) -> Element {
        let label_elem = Text::new(&self.label)
            .color(Color::White)
            .into_element();

        if !self.visible || self.content.is_empty() {
            return label_elem;
        }

        let tooltip_elem = RnkBox::new()
            .padding_x(1.0)
            .background(Color::Ansi256(240))
            .child(
                Text::new(&self.content)
                    .color(Color::White)
                    .into_element(),
            )
            .into_element();

        let (direction, children) = match self.position {
            TooltipPosition::Top => (
                FlexDirection::Column,
                vec![tooltip_elem, label_elem],
            ),
            TooltipPosition::Bottom => (
                FlexDirection::Column,
                vec![label_elem, tooltip_elem],
            ),
            TooltipPosition::Left => (
                FlexDirection::Row,
                vec![tooltip_elem, Text::new(" ").into_element(), label_elem],
            ),
            TooltipPosition::Right => (
                FlexDirection::Row,
                vec![label_elem, Text::new(" ").into_element(), tooltip_elem],
            ),
        };

        RnkBox::new()
            .flex_direction(direction)
            .children(children)
            .into_element()
    }
}

impl Default for Tooltip {
    fn default() -> Self {
        Self::new("")
    }
}

/// Create a tooltip
pub fn tooltip(label: impl Into<String>, content: impl Into<String>) -> Element {
    Tooltip::new(label).content(content).into_element()
}

/// Create a tooltip on the right
pub fn tooltip_right(label: impl Into<String>, content: impl Into<String>) -> Element {
    Tooltip::new(label)
        .content(content)
        .position(TooltipPosition::Right)
        .into_element()
}

/// Create a tooltip on the left
pub fn tooltip_left(label: impl Into<String>, content: impl Into<String>) -> Element {
    Tooltip::new(label)
        .content(content)
        .position(TooltipPosition::Left)
        .into_element()
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_tooltip_creation() {
        let t = Tooltip::new("Label");
        assert_eq!(t.label, "Label");
    }

    #[test]
    fn test_tooltip_content() {
        let t = Tooltip::new("Label").content("Info");
        assert_eq!(t.content, "Info");
    }

    #[test]
    fn test_tooltip_positions() {
        let _ = Tooltip::new("L").content("C").position(TooltipPosition::Top).into_element();
        let _ = Tooltip::new("L").content("C").position(TooltipPosition::Bottom).into_element();
        let _ = Tooltip::new("L").content("C").position(TooltipPosition::Left).into_element();
        let _ = Tooltip::new("L").content("C").position(TooltipPosition::Right).into_element();
    }

    #[test]
    fn test_tooltip_helpers() {
        let _ = tooltip("Label", "Content");
        let _ = tooltip_right("Label", "Content");
        let _ = tooltip_left("Label", "Content");
    }
}