ratatui-interact 0.5.3

Interactive TUI components for ratatui with focus management and mouse support
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
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
//! List picker widget
//!
//! A scrollable list with selection cursor for picking from a set of items.
//!
//! # Example
//!
//! ```rust
//! use ratatui_interact::components::{ListPicker, ListPickerState, ListPickerStyle};
//! use ratatui::text::Line;
//! use ratatui::layout::Rect;
//!
//! // Create items
//! let items = vec!["Option 1", "Option 2", "Option 3"];
//!
//! // Create state
//! let mut state = ListPickerState::new(items.len());
//!
//! // Create picker
//! let picker = ListPicker::new(&items, &state)
//!     .title("Select an option")
//!     .render_item(|item, idx, selected| {
//!         let text = if selected {
//!             format!("▶ {}", item)
//!         } else {
//!             format!("  {}", item)
//!         };
//!         vec![Line::from(text)]
//!     });
//! ```

use ratatui::{
    buffer::Buffer,
    layout::Rect,
    style::{Color, Modifier, Style},
    text::{Line, Span},
    widgets::{Block, Borders, Paragraph, Widget, Wrap},
};

/// State for the list picker widget
#[derive(Debug, Clone, Default)]
pub struct ListPickerState {
    /// Currently selected index
    pub selected_index: usize,
    /// Scroll offset
    pub scroll: u16,
    /// Total number of items
    pub total_items: usize,
}

impl ListPickerState {
    /// Create a new list picker state with the given number of items
    pub fn new(total_items: usize) -> Self {
        Self {
            selected_index: 0,
            scroll: 0,
            total_items,
        }
    }

    /// Move selection up
    pub fn select_prev(&mut self) {
        if self.selected_index > 0 {
            self.selected_index -= 1;
        }
    }

    /// Move selection down
    pub fn select_next(&mut self) {
        if self.selected_index + 1 < self.total_items {
            self.selected_index += 1;
        }
    }

    /// Select a specific index
    pub fn select(&mut self, index: usize) {
        if index < self.total_items {
            self.selected_index = index;
        }
    }

    /// Move selection to first item
    pub fn select_first(&mut self) {
        self.selected_index = 0;
    }

    /// Move selection to last item
    pub fn select_last(&mut self) {
        if self.total_items > 0 {
            self.selected_index = self.total_items - 1;
        }
    }

    /// Ensure selected item is visible in viewport
    pub fn ensure_visible(&mut self, viewport_height: usize) {
        if viewport_height == 0 {
            return;
        }

        if self.selected_index < self.scroll as usize {
            self.scroll = self.selected_index as u16;
        } else if self.selected_index >= self.scroll as usize + viewport_height {
            self.scroll = (self.selected_index - viewport_height + 1) as u16;
        }
    }

    /// Update total items count
    pub fn set_total(&mut self, total: usize) {
        self.total_items = total;
        if self.selected_index >= total && total > 0 {
            self.selected_index = total - 1;
        }
    }
}

/// Style configuration for list picker
#[derive(Debug, Clone)]
pub struct ListPickerStyle {
    /// Style for selected items
    pub selected_style: Style,
    /// Style for normal items
    pub normal_style: Style,
    /// Style for the selection indicator
    pub indicator_style: Style,
    /// Border style
    pub border_style: Style,
    /// Selection indicator character(s)
    pub indicator: &'static str,
    /// Empty indicator (same width as indicator)
    pub indicator_empty: &'static str,
    /// Whether to show borders
    pub bordered: bool,
}

impl Default for ListPickerStyle {
    fn default() -> Self {
        Self {
            selected_style: Style::default()
                .fg(Color::Yellow)
                .add_modifier(Modifier::BOLD),
            normal_style: Style::default().fg(Color::White),
            indicator_style: Style::default().fg(Color::Yellow),
            border_style: Style::default().fg(Color::Cyan),
            indicator: "",
            indicator_empty: "  ",
            bordered: true,
        }
    }
}

impl From<&crate::theme::Theme> for ListPickerStyle {
    fn from(theme: &crate::theme::Theme) -> Self {
        let p = &theme.palette;
        Self {
            selected_style: Style::default().fg(p.primary).add_modifier(Modifier::BOLD),
            normal_style: Style::default().fg(p.text),
            indicator_style: Style::default().fg(p.primary),
            border_style: Style::default().fg(p.border_accent),
            indicator: "",
            indicator_empty: "  ",
            bordered: true,
        }
    }
}

impl ListPickerStyle {
    /// Style with arrow indicator
    pub fn arrow() -> Self {
        Self::default()
    }

    /// Style with bracket indicator
    pub fn bracket() -> Self {
        Self {
            indicator: "> ",
            indicator_empty: "  ",
            ..Default::default()
        }
    }

    /// Style with checkbox indicator
    pub fn checkbox() -> Self {
        Self {
            indicator: "[x] ",
            indicator_empty: "[ ] ",
            selected_style: Style::default().fg(Color::Green),
            ..Default::default()
        }
    }

    /// Set whether to show borders
    pub fn bordered(mut self, bordered: bool) -> Self {
        self.bordered = bordered;
        self
    }
}

/// Default render function type
type DefaultRenderFn<T> = fn(&T, usize, bool) -> Vec<Line<'static>>;

/// List picker widget
pub struct ListPicker<'a, T, F = DefaultRenderFn<T>>
where
    F: Fn(&T, usize, bool) -> Vec<Line<'static>>,
{
    items: &'a [T],
    state: &'a ListPickerState,
    style: ListPickerStyle,
    title: Option<&'a str>,
    footer: Option<Vec<Line<'static>>>,
    render_fn: F,
}

impl<'a, T: std::fmt::Display> ListPicker<'a, T, DefaultRenderFn<T>> {
    /// Create a new list picker with default rendering
    pub fn new(items: &'a [T], state: &'a ListPickerState) -> Self {
        Self {
            items,
            state,
            style: ListPickerStyle::default(),
            title: None,
            footer: None,
            render_fn: |item, _idx, _selected| vec![Line::from(item.to_string())],
        }
    }
}

impl<'a, T, F> ListPicker<'a, T, F>
where
    F: Fn(&T, usize, bool) -> Vec<Line<'static>>,
{
    /// Set the render function for items
    ///
    /// The function receives: item reference, index, is_selected
    /// Returns a Vec of Lines (to support multi-line items)
    pub fn render_item<G>(self, render_fn: G) -> ListPicker<'a, T, G>
    where
        G: Fn(&T, usize, bool) -> Vec<Line<'static>>,
    {
        ListPicker {
            items: self.items,
            state: self.state,
            style: self.style,
            title: self.title,
            footer: self.footer,
            render_fn,
        }
    }

    /// Set the title
    pub fn title(mut self, title: &'a str) -> Self {
        self.title = Some(title);
        self
    }

    /// Set the footer lines
    pub fn footer(mut self, footer: Vec<Line<'static>>) -> Self {
        self.footer = Some(footer);
        self
    }

    /// Set the style
    pub fn style(mut self, style: ListPickerStyle) -> Self {
        self.style = style;
        self
    }

    /// Apply a theme to this list picker.
    pub fn theme(self, theme: &crate::theme::Theme) -> Self {
        self.style(ListPickerStyle::from(theme))
    }

    /// Build the lines for rendering
    fn build_lines(&self, _area: Rect, inner_height: u16) -> Vec<Line<'static>> {
        let mut lines = Vec::new();

        // Header
        if let Some(title) = self.title {
            lines.push(Line::from(vec![Span::styled(
                title.to_string(),
                Style::default()
                    .fg(Color::Cyan)
                    .add_modifier(Modifier::BOLD),
            )]));
            lines.push(Line::from("")); // Empty line after title
        }

        // Calculate available height for items
        let header_lines = if self.title.is_some() { 2 } else { 0 };
        let footer_lines = self.footer.as_ref().map(|f| f.len()).unwrap_or(0);
        let available_height = inner_height as usize - header_lines - footer_lines;

        // Items
        if self.items.is_empty() {
            lines.push(Line::from(vec![Span::styled(
                "No items",
                Style::default().fg(Color::Gray),
            )]));
        } else {
            let scroll = self.state.scroll as usize;
            for (idx, item) in self
                .items
                .iter()
                .enumerate()
                .skip(scroll)
                .take(available_height)
            {
                let is_selected = idx == self.state.selected_index;
                let indicator = if is_selected {
                    self.style.indicator
                } else {
                    self.style.indicator_empty
                };

                let item_style = if is_selected {
                    self.style.selected_style
                } else {
                    self.style.normal_style
                };

                let item_lines = (self.render_fn)(item, idx, is_selected);
                for (line_idx, line) in item_lines.into_iter().enumerate() {
                    let mut spans = Vec::new();

                    // Only show indicator on first line of item
                    if line_idx == 0 {
                        spans.push(Span::styled(
                            indicator.to_string(),
                            self.style.indicator_style,
                        ));
                    } else {
                        // Indent continuation lines
                        spans.push(Span::raw(" ".repeat(self.style.indicator.len())));
                    }

                    // Add the line content with appropriate style
                    for span in line.spans {
                        spans.push(Span::styled(span.content.to_string(), item_style));
                    }

                    lines.push(Line::from(spans));
                }
            }
        }

        // Footer
        if let Some(footer) = &self.footer {
            for line in footer {
                lines.push(line.clone());
            }
        }

        lines
    }
}

impl<'a, T, F> Widget for ListPicker<'a, T, F>
where
    F: Fn(&T, usize, bool) -> Vec<Line<'static>>,
{
    fn render(self, area: Rect, buf: &mut Buffer) {
        let block = if self.style.bordered {
            Some(
                Block::default()
                    .borders(Borders::ALL)
                    .border_style(self.style.border_style),
            )
        } else {
            None
        };

        let inner = if let Some(ref block) = block {
            block.inner(area)
        } else {
            area
        };

        if let Some(block) = block {
            block.render(area, buf);
        }

        let lines = self.build_lines(area, inner.height);
        let paragraph = Paragraph::new(lines).wrap(Wrap { trim: false });
        paragraph.render(inner, buf);
    }
}

/// Helper function to create a simple footer with key hints
pub fn key_hints_footer(hints: &[(&str, &str)]) -> Vec<Line<'static>> {
    let mut spans = Vec::new();
    for (idx, (key, desc)) in hints.iter().enumerate() {
        if idx > 0 {
            spans.push(Span::raw(" | "));
        }
        spans.push(Span::styled(
            key.to_string(),
            Style::default().fg(Color::Green),
        ));
        spans.push(Span::raw(format!(": {}", desc)));
    }
    vec![Line::from(""), Line::from(spans)]
}

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

    #[test]
    fn test_state_new() {
        let state = ListPickerState::new(10);
        assert_eq!(state.selected_index, 0);
        assert_eq!(state.scroll, 0);
        assert_eq!(state.total_items, 10);
    }

    #[test]
    fn test_state_navigation() {
        let mut state = ListPickerState::new(5);
        assert_eq!(state.selected_index, 0);

        state.select_next();
        assert_eq!(state.selected_index, 1);

        state.select_prev();
        assert_eq!(state.selected_index, 0);

        state.select_prev(); // Should not go below 0
        assert_eq!(state.selected_index, 0);

        state.select_last();
        assert_eq!(state.selected_index, 4);

        state.select_next(); // Should not go above total
        assert_eq!(state.selected_index, 4);
    }

    #[test]
    fn test_select_first_and_last() {
        let mut state = ListPickerState::new(10);
        state.selected_index = 5;

        state.select_first();
        assert_eq!(state.selected_index, 0);

        state.select_last();
        assert_eq!(state.selected_index, 9);
    }

    #[test]
    fn test_select_specific_index() {
        let mut state = ListPickerState::new(10);

        state.select(5);
        assert_eq!(state.selected_index, 5);

        // Should clamp to valid range
        state.select(100);
        assert_eq!(state.selected_index, 5); // Unchanged because out of range
    }

    #[test]
    fn test_ensure_visible() {
        let mut state = ListPickerState::new(20);
        state.selected_index = 15;
        state.ensure_visible(10);
        assert!(state.scroll >= 6); // 15 - 10 + 1 = 6
    }

    #[test]
    fn test_ensure_visible_scroll_up() {
        let mut state = ListPickerState::new(20);
        state.scroll = 10;
        state.selected_index = 5;
        state.ensure_visible(10);
        assert_eq!(state.scroll, 5);
    }

    #[test]
    fn test_ensure_visible_zero_viewport() {
        let mut state = ListPickerState::new(20);
        state.selected_index = 10;
        state.scroll = 5;
        state.ensure_visible(0);
        // Should not change scroll on zero viewport
        assert_eq!(state.scroll, 5);
    }

    #[test]
    fn test_set_total() {
        let mut state = ListPickerState::new(10);
        state.selected_index = 8;

        // Reduce total, selected should be clamped
        state.set_total(5);
        assert_eq!(state.total_items, 5);
        assert_eq!(state.selected_index, 4);

        // Increase total
        state.set_total(20);
        assert_eq!(state.total_items, 20);
        assert_eq!(state.selected_index, 4); // Unchanged
    }

    #[test]
    fn test_empty_list() {
        let mut state = ListPickerState::new(0);
        state.select_next();
        assert_eq!(state.selected_index, 0);
        state.select_last();
        assert_eq!(state.selected_index, 0);
    }

    #[test]
    fn test_list_picker_render() {
        let items = vec!["Item 1", "Item 2", "Item 3"];
        let state = ListPickerState::new(items.len());
        let picker = ListPicker::new(&items, &state).title("Test");

        let mut buf = Buffer::empty(Rect::new(0, 0, 40, 10));
        picker.render(Rect::new(0, 0, 40, 10), &mut buf);
        // Just verify it doesn't panic
    }

    #[test]
    fn test_list_picker_with_custom_render() {
        let items = vec!["A", "B", "C"];
        let state = ListPickerState::new(items.len());
        let picker = ListPicker::new(&items, &state).render_item(|item, idx, selected| {
            let prefix = if selected { "> " } else { "  " };
            vec![Line::from(format!("{}{}. {}", prefix, idx + 1, item))]
        });

        let mut buf = Buffer::empty(Rect::new(0, 0, 40, 10));
        picker.render(Rect::new(0, 0, 40, 10), &mut buf);
    }

    #[test]
    fn test_list_picker_styles() {
        let arrow = ListPickerStyle::arrow();
        assert_eq!(arrow.indicator, "");

        let bracket = ListPickerStyle::bracket();
        assert_eq!(bracket.indicator, "> ");

        let checkbox = ListPickerStyle::checkbox();
        assert_eq!(checkbox.indicator, "[x] ");
        assert_eq!(checkbox.indicator_empty, "[ ] ");
    }

    #[test]
    fn test_list_picker_style_bordered() {
        let style = ListPickerStyle::default().bordered(false);
        assert!(!style.bordered);

        let style = ListPickerStyle::default().bordered(true);
        assert!(style.bordered);
    }

    #[test]
    fn test_key_hints_footer() {
        let footer = key_hints_footer(&[("↑↓", "Navigate"), ("Enter", "Select")]);
        assert_eq!(footer.len(), 2);
    }

    #[test]
    fn test_key_hints_footer_empty() {
        let footer = key_hints_footer(&[]);
        assert_eq!(footer.len(), 2); // Empty line + spans line
    }
}