ratkit 0.2.15

A comprehensive collection of reusable TUI components for ratatui including resizable splits, tree views, markdown rendering, toast notifications, dialogs, and terminal embedding
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

//! Line renderer for normalized document viewports.

use ratatui::{
    buffer::Buffer,
    layout::Rect,
    style::{Color, Style},
    text::Line,
};

use crate::widgets::document_viewer::{
    extensions::{gutter_width, is_line_selected, render_gutter, selected_line_style},
    foundation::DocumentLine,
    state::{DisplaySettings, ScrollState, SelectionState},
};

const CURRENT_LINE_BG: Color = Color::Rgb(38, 52, 63);

/// Renders visible document lines into the target area.
pub fn render_document_lines(
    area: Rect,
    buf: &mut Buffer,
    lines: &[DocumentLine],
    scroll: &ScrollState,
    display: &DisplaySettings,
    selection: Option<&SelectionState>,
) {
    if area.is_empty() {
        return;
    }

    let gutter_width = gutter_width(lines.len(), display);
    let mut local_scroll = scroll.clone();
    local_scroll.ensure_current_visible(area.height as usize);

    for (row, line_index) in local_scroll.visible_range(area.height as usize).enumerate() {
        render_line(
            area,
            buf,
            lines,
            line_index,
            row,
            gutter_width,
            &local_scroll,
            display,
            selection,
        );
    }
}

/// Renders one visible line.
fn render_line(
    area: Rect,
    buf: &mut Buffer,
    lines: &[DocumentLine],
    line_index: usize,
    row: usize,
    gutter_width: usize,
    scroll: &ScrollState,
    display: &DisplaySettings,
    selection: Option<&SelectionState>,
) {
    let Some(document_line) = lines.get(line_index) else {
        return;
    };
    let y = area.y + row as u16;
    let is_current = line_index == scroll.current_line_index();
    let is_selected = is_line_selected(selection, line_index);
    buf.set_style(
        Rect {
            y,
            height: 1,
            ..area
        },
        line_style(is_current, is_selected, display),
    );
    render_gutter(area.x, y, gutter_width, line_index, scroll, display, buf);
    let line = Line::from(document_line.spans.clone());
    buf.set_line(
        area.x + gutter_width as u16,
        y,
        &line,
        area.width.saturating_sub(gutter_width as u16),
    );
}

/// Returns the row background style for a rendered line.
fn line_style(is_current: bool, is_selected: bool, display: &DisplaySettings) -> Style {
    if is_selected {
        selected_line_style(true)
    } else if is_current && display.highlight_current_line {
        Style::default().bg(CURRENT_LINE_BG)
    } else {
        Style::default()
    }
}