superlighttui 0.20.1

Super Light TUI - A lightweight, ergonomic terminal UI library
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

// Widget response types introduced in v0.20.0.
//
// These wrap a [`Response`] alongside widget-specific interaction data
// (clicked segment index, drag state, search highlight info). Each implements
// [`Deref<Target = Response>`] so callers can read the standard `hovered`,
// `clicked`, `rect`, and `focused` fields without explicit field navigation.

/// Response from [`Context::breadcrumb`](crate::Context::breadcrumb).
///
/// Wraps the row-level [`Response`] and exposes the index of the clicked
/// segment (if any). Implements `Deref<Target = Response>` so `r.hovered`,
/// `r.rect`, etc. work directly.
///
/// # Example
///
/// ```no_run
/// # slt::run(|ui: &mut slt::Context| {
/// let r = ui.breadcrumb(&["Home", "Settings", "Profile"]).show();
/// if let Some(i) = r.clicked_segment {
///     // navigate to segment `i`
/// }
/// if r.hovered {
///     // whole bar hovered
/// }
/// # });
/// ```
#[derive(Debug, Clone, Default)]
#[must_use = "BreadcrumbResponse contains interaction state — check .clicked_segment, .hovered, or .rect"]
pub struct BreadcrumbResponse {
    /// The row-level interaction response (hover, rect, focus).
    pub response: Response,
    /// Index of the clicked segment, if any.
    pub clicked_segment: Option<usize>,
}

impl std::ops::Deref for BreadcrumbResponse {
    type Target = Response;
    fn deref(&self) -> &Response {
        &self.response
    }
}

/// Response from [`Context::gauge`](crate::Context::gauge) and
/// [`Context::line_gauge`](crate::Context::line_gauge).
///
/// Wraps the row-level [`Response`] plus the rendered ratio so callers can
/// confirm the displayed value (clamped to `0.0..=1.0`). Implements
/// `Deref<Target = Response>` so `r.hovered` etc. work directly.
///
/// Note: `ratio` was widened from `f32` to `f64` in v0.20.0 so the gauge
/// family aligns with `animate_value`, chart APIs, and `progress_bar`.
#[derive(Debug, Clone, Default)]
#[must_use = "GaugeResponse contains interaction state — check .hovered or .ratio"]
pub struct GaugeResponse {
    /// The row-level interaction response.
    pub response: Response,
    /// The clamped ratio that was rendered (always `0.0..=1.0`).
    pub ratio: f64,
}

impl std::ops::Deref for GaugeResponse {
    type Target = Response;
    fn deref(&self) -> &Response {
        &self.response
    }
}

/// Response from [`Context::split_pane`](crate::Context::split_pane) and
/// [`Context::vsplit_pane`](crate::Context::vsplit_pane).
///
/// Wraps the row-level [`Response`] of the outer container plus drag state.
/// Implements `Deref<Target = Response>` so `r.hovered` etc. work directly.
#[derive(Debug, Clone, Default)]
#[must_use = "SplitPaneResponse contains interaction state — check .ratio, .drag_active, or .hovered"]
pub struct SplitPaneResponse {
    /// The row/column-level interaction response.
    pub response: Response,
    /// Current ratio after this frame's interaction (mirrors `state.ratio`).
    pub ratio: f64,
    /// Whether the handle was actively being dragged this frame.
    pub drag_active: bool,
}

impl std::ops::Deref for SplitPaneResponse {
    type Target = Response;
    fn deref(&self) -> &Response {
        &self.response
    }
}

/// Response from [`Context::scrollable_with_gutter`](crate::Context::scrollable_with_gutter).
///
/// Wraps the [`Response`] for the scrollable region plus search-result
/// metadata: the index of the currently focused highlight (if any) and the
/// total count of registered highlights.
#[derive(Debug, Clone, Default)]
#[must_use = "GutterResponse contains interaction state — check .current_highlight or .hovered"]
pub struct GutterResponse {
    /// The scrollable region's interaction response.
    pub response: Response,
    /// Index of the currently focused highlight, if any.
    pub current_highlight: Option<usize>,
    /// Total number of active highlights.
    pub total_highlights: usize,
}

impl std::ops::Deref for GutterResponse {
    type Target = Response;
    fn deref(&self) -> &Response {
        &self.response
    }
}