envision 0.15.1

A ratatui framework for collaborative TUI development with headless testing 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

//! Rendering functions for the LoadingList component.
//!
//! Extracted from the main loading_list module to keep file sizes manageable.

use ratatui::prelude::*;
use ratatui::widgets::{Block, Borders, List, ListItem};

use super::*;
use crate::theme::Theme;

/// Renders the loading list into the given frame area.
pub(super) fn render_loading_list<T: Clone>(
    state: &LoadingListState<T>,
    frame: &mut Frame,
    area: Rect,
    theme: &Theme,
    focused: bool,
    disabled: bool,
) {
    if area.width == 0 || area.height == 0 {
        return;
    }

    crate::annotation::with_registry(|reg| {
        let mut ann = crate::annotation::Annotation::loading_list("loading_list")
            .with_focus(focused)
            .with_disabled(disabled);
        if let Some(idx) = state.selected {
            ann = ann.with_selected(true).with_value(idx.to_string());
        }
        reg.register(area, ann);
    });

    let block = if let Some(title) = &state.title {
        Block::default().borders(Borders::ALL).title(title.as_str())
    } else {
        Block::default().borders(Borders::ALL)
    };

    let inner = block.inner(area);
    frame.render_widget(block, area);

    if state.items.is_empty() || inner.height == 0 {
        return;
    }

    // Construct a local ScrollState for virtual scrolling and scrollbar
    let mut bar_scroll = ScrollState::new(state.items.len());
    bar_scroll.set_viewport_height(inner.height as usize);
    if let Some(sel) = state.selected {
        bar_scroll.ensure_visible(sel);
    }
    let range = bar_scroll.visible_range();

    let items: Vec<ListItem> = state.items[range.clone()]
        .iter()
        .enumerate()
        .map(|(view_idx, item)| {
            let actual_idx = range.start + view_idx;
            let is_selected = state.selected == Some(actual_idx);
            let select_marker = if is_selected { "\u{25b8}" } else { " " };

            let content = if state.show_indicators {
                let state_symbol = item.state.symbol(state.spinner_frame);

                if let ItemState::Error(msg) = &item.state {
                    format!(
                        "{} {} {} - Error: {}",
                        select_marker, state_symbol, item.label, msg
                    )
                } else {
                    format!("{} {} {}", select_marker, state_symbol, item.label)
                }
            } else if let ItemState::Error(msg) = &item.state {
                format!("{} {} - Error: {}", select_marker, item.label, msg)
            } else {
                format!("{} {}", select_marker, item.label)
            };

            let style = if is_selected {
                theme.focused_bold_style()
            } else {
                item.state.style(theme)
            };

            ListItem::new(content).style(style)
        })
        .collect();

    let list = List::new(items);
    frame.render_widget(list, inner);

    // Render scrollbar when content exceeds viewport
    crate::scroll::render_scrollbar_inside_border(&bar_scroll, frame, area, theme);
}