Skip to main content

waxterm/widgets/
multi_select.rs

1use std::fmt::Display;
2
3use ratatui::layout::Rect;
4use ratatui::style::{Color, Modifier, Style};
5use ratatui::text::{Line, Span};
6use ratatui::widgets::Paragraph;
7use ratatui::Frame;
8
9use crate::input::KeyPress;
10
11use super::WidgetResult;
12
13/// Multi-selection checkbox list (arrow keys + Space to toggle + Enter to confirm).
14pub struct MultiSelectList<T> {
15    label: String,
16    items: Vec<T>,
17    checked: Vec<bool>,
18    cursor: usize,
19}
20
21impl<T: Display + Clone> MultiSelectList<T> {
22    pub fn new(label: impl Into<String>, items: Vec<T>) -> Self {
23        let len = items.len();
24        Self {
25            label: label.into(),
26            items,
27            checked: vec![false; len],
28            cursor: 0,
29        }
30    }
31
32    /// Returns indices of all checked items.
33    pub fn selected_indices(&self) -> Vec<usize> {
34        self.checked
35            .iter()
36            .enumerate()
37            .filter_map(|(i, &c)| if c { Some(i) } else { None })
38            .collect()
39    }
40
41    pub fn handle_key(&mut self, key: &KeyPress) -> WidgetResult<Vec<T>> {
42        match key {
43            KeyPress::ArrowUp => {
44                if self.cursor > 0 {
45                    self.cursor -= 1;
46                }
47                WidgetResult::Pending
48            }
49            KeyPress::ArrowDown => {
50                if self.cursor + 1 < self.items.len() {
51                    self.cursor += 1;
52                }
53                WidgetResult::Pending
54            }
55            KeyPress::Char(b' ') => {
56                if self.cursor < self.checked.len() {
57                    self.checked[self.cursor] = !self.checked[self.cursor];
58                }
59                WidgetResult::Pending
60            }
61            KeyPress::Enter => {
62                let selected: Vec<T> = self
63                    .items
64                    .iter()
65                    .zip(self.checked.iter())
66                    .filter_map(|(item, &c)| if c { Some(item.clone()) } else { None })
67                    .collect();
68                WidgetResult::Confirmed(selected)
69            }
70            KeyPress::Escape => WidgetResult::Cancelled,
71            _ => WidgetResult::Pending,
72        }
73    }
74
75    /// Render the list. Uses up to `items.len() + 1` rows (label + items).
76    pub fn render(&self, frame: &mut Frame, area: Rect) {
77        let mut lines = Vec::with_capacity(self.items.len() + 1);
78
79        lines.push(Line::from(Span::styled(
80            &self.label,
81            Style::default().fg(Color::Cyan),
82        )));
83
84        for (i, item) in self.items.iter().enumerate() {
85            let check = if self.checked[i] { "[x]" } else { "[ ]" };
86            let marker = if i == self.cursor { "> " } else { "  " };
87            let style = if i == self.cursor {
88                Style::default()
89                    .fg(Color::Yellow)
90                    .add_modifier(Modifier::BOLD)
91            } else {
92                Style::default()
93            };
94            lines.push(Line::from(Span::styled(
95                format!("{marker}{check} {item}"),
96                style,
97            )));
98        }
99
100        let paragraph = Paragraph::new(lines);
101        frame.render_widget(paragraph, area);
102    }
103}
104
105#[cfg(test)]
106mod tests {
107    use super::*;
108
109    #[test]
110    fn test_toggle_and_confirm() {
111        let mut ms = MultiSelectList::new("Pick:", vec!["a", "b", "c"]);
112        // Toggle first item
113        ms.handle_key(&KeyPress::Char(b' '));
114        // Move down, toggle third
115        ms.handle_key(&KeyPress::ArrowDown);
116        ms.handle_key(&KeyPress::ArrowDown);
117        ms.handle_key(&KeyPress::Char(b' '));
118        assert_eq!(
119            ms.handle_key(&KeyPress::Enter),
120            WidgetResult::Confirmed(vec!["a", "c"])
121        );
122    }
123
124    #[test]
125    fn test_empty_confirm() {
126        let mut ms = MultiSelectList::new("Pick:", vec!["a", "b"]);
127        assert_eq!(
128            ms.handle_key(&KeyPress::Enter),
129            WidgetResult::Confirmed(Vec::<&str>::new())
130        );
131    }
132
133    #[test]
134    fn test_selected_indices() {
135        let mut ms = MultiSelectList::new("Pick:", vec!["a", "b", "c"]);
136        ms.handle_key(&KeyPress::ArrowDown);
137        ms.handle_key(&KeyPress::Char(b' '));
138        assert_eq!(ms.selected_indices(), vec![1]);
139    }
140}