Skip to main content

comb/widgets/
scroll.rs

1//! A scrollable block of lines and the low-level scrollbar it uses.
2
3use crate::core::buffer::Buffer;
4use crate::core::geom::Rect;
5use crate::core::text::Line;
6use crate::term::event::MouseKind;
7use crate::widgets::scrollbar::Scrollbar;
8use crate::widgets::Palette;
9
10/// A scrollable view over a block of styled lines. Uses a customizable
11/// [`Scrollbar`] (draggable thumb, custom glyphs) when content overflows.
12#[derive(Default)]
13pub struct ScrollView {
14    pub lines: Vec<Line>,
15    pub offset: usize,
16    pub scrollbar: Scrollbar,
17}
18
19impl ScrollView {
20    pub fn new(lines: Vec<Line>) -> Self {
21        ScrollView {
22            lines,
23            offset: 0,
24            scrollbar: Scrollbar::default(),
25        }
26    }
27
28    pub fn scroll_by(&mut self, delta: isize) {
29        let h = self.lines.len();
30        let last = h.saturating_sub(1) as isize;
31        self.offset = (self.offset as isize + delta).clamp(0, last.max(0)) as usize;
32    }
33
34    pub fn render(&mut self, buf: &mut Buffer, area: Rect, pal: &Palette) {
35        if area.is_empty() {
36            return;
37        }
38        // Opaque base — stacked windows must not show through empty cells.
39        buf.paint(area, pal.panel);
40        let h = area.height as usize;
41        let overflow = self.lines.len() > h;
42        let content = self.scrollbar.content_area(area, overflow);
43        self.offset = self.offset.min(self.lines.len().saturating_sub(h));
44        buf.set_lines_on(content, &self.lines, self.offset, pal.panel);
45        if overflow {
46            let mut bar = self.scrollbar.clone();
47            if bar.style.track == crate::core::style::Style::new() {
48                bar.style.track = pal.track;
49                bar.style.thumb = pal.thumb;
50                bar.style.thumb_active = pal.thumb;
51            }
52            bar.render(buf, bar.area(area), self.lines.len(), h, self.offset);
53        }
54    }
55
56    /// Handle wheel / drag over `area` (content + scrollbar strip).
57    pub fn handle_mouse(&mut self, area: Rect, kind: MouseKind, col: u16, row: u16) -> bool {
58        let h = area.height as usize;
59        let overflow = self.lines.len() > h;
60        if !overflow {
61            return false;
62        }
63        let bar_area = self.scrollbar.area(area);
64        if self.scrollbar.is_dragging() || bar_area.contains(col, row) {
65            return self.scrollbar.on_mouse(
66                bar_area,
67                self.lines.len(),
68                h,
69                &mut self.offset,
70                kind,
71                col,
72                row,
73            );
74        }
75        let content = self.scrollbar.content_area(area, true);
76        if !content.contains(col, row) {
77            return false;
78        }
79        match kind {
80            MouseKind::ScrollUp => {
81                self.scroll_by(-3);
82                true
83            }
84            MouseKind::ScrollDown => {
85                self.scroll_by(3);
86                true
87            }
88            MouseKind::Up => {
89                self.scrollbar.end_drag();
90                false
91            }
92            _ => false,
93        }
94    }
95}
96
97#[cfg(test)]
98mod tests {
99    use super::*;
100    use crate::core::text::Span;
101    use crate::term::event::MouseButton;
102
103    #[test]
104    fn drag_on_custom_bar_starts_drag() {
105        let mut view = ScrollView::new(
106            (0..30)
107                .map(|i| Line::from(Span::raw(format!("line {i}"))))
108                .collect(),
109        );
110        view.scrollbar.style.track_glyph = '░';
111        view.scrollbar.style.thumb_glyph = '▐';
112        let area = Rect::new(0, 0, 10, 8);
113        view.handle_mouse(area, MouseKind::Down(MouseButton::Left), 9, 0);
114        assert!(view.scrollbar.is_dragging());
115    }
116}