rnk 0.19.1

A React-like declarative terminal UI framework for Rust, inspired by Ink and Bubbletea
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

//! Terminal control helpers extracted from App orchestration.

use std::sync::Arc;

use super::Terminal;
use super::registry::{AppRuntime, ModeSwitch, Printable};
use super::render_to_string::render_to_string;

/// Handles terminal mode switching, terminal commands, and inline println rendering.
pub(crate) struct TerminalController;

impl TerminalController {
    pub(crate) fn handle_mode_switch(
        terminal: &mut Terminal,
        runtime: &Arc<AppRuntime>,
        mode_switch: ModeSwitch,
    ) -> std::io::Result<()> {
        match mode_switch {
            ModeSwitch::EnterAltScreen => {
                if !terminal.is_alt_screen() {
                    terminal.switch_to_alt_screen()?;
                    runtime.set_alt_screen_state(true);
                    terminal.repaint();
                }
            }
            ModeSwitch::ExitAltScreen => {
                if terminal.is_alt_screen() {
                    terminal.switch_to_inline()?;
                    runtime.set_alt_screen_state(false);
                    terminal.repaint();
                }
            }
        }
        Ok(())
    }

    pub(crate) fn handle_terminal_cmd(
        terminal: &mut Terminal,
        runtime: &Arc<AppRuntime>,
        cmd: crate::cmd::TerminalCmd,
        last_width: &mut u16,
        last_height: &mut u16,
    ) -> std::io::Result<()> {
        use crate::cmd::TerminalCmd;
        use crossterm::{cursor, execute, terminal as ct};
        use std::io::stdout;

        match cmd {
            TerminalCmd::ClearScreen => {
                if terminal.is_alt_screen() {
                    execute!(
                        stdout(),
                        ct::Clear(ct::ClearType::All),
                        cursor::MoveTo(0, 0)
                    )?;
                } else {
                    terminal.clear()?;
                }
            }
            TerminalCmd::HideCursor => {
                execute!(stdout(), cursor::Hide)?;
            }
            TerminalCmd::ShowCursor => {
                execute!(stdout(), cursor::Show)?;
            }
            TerminalCmd::SetWindowTitle(title) => {
                execute!(stdout(), ct::SetTitle(&title))?;
            }
            TerminalCmd::WindowSize => {
                // This triggers a resize check on next render.
                *last_width = 0;
                *last_height = 0;
            }
            TerminalCmd::EnterAltScreen => {
                if !terminal.is_alt_screen() {
                    terminal.switch_to_alt_screen()?;
                    runtime.set_alt_screen_state(true);
                    terminal.repaint();
                }
            }
            TerminalCmd::ExitAltScreen => {
                if terminal.is_alt_screen() {
                    terminal.switch_to_inline()?;
                    runtime.set_alt_screen_state(false);
                    terminal.repaint();
                }
            }
            TerminalCmd::EnableMouse => {
                crate::hooks::use_mouse::set_mouse_enabled(true);
                execute!(stdout(), crossterm::event::EnableMouseCapture)?;
            }
            TerminalCmd::DisableMouse => {
                crate::hooks::use_mouse::set_mouse_enabled(false);
                execute!(stdout(), crossterm::event::DisableMouseCapture)?;
            }
            TerminalCmd::EnableBracketedPaste => {
                execute!(stdout(), crossterm::event::EnableBracketedPaste)?;
            }
            TerminalCmd::DisableBracketedPaste => {
                execute!(stdout(), crossterm::event::DisableBracketedPaste)?;
            }
        }
        Ok(())
    }

    pub(crate) fn handle_println_messages(
        terminal: &mut Terminal,
        messages: &[Printable],
    ) -> std::io::Result<()> {
        // Println only works in inline mode.
        if terminal.is_alt_screen() {
            return Ok(());
        }

        // Get terminal width for rendering elements.
        let (width, _) = Terminal::size().unwrap_or((80, 24));

        for message in messages {
            match message {
                Printable::Text(text) => {
                    terminal.println(text)?;
                }
                Printable::Element(element) => {
                    let rendered = render_to_string(element, width);
                    terminal.println(&rendered)?;
                }
            }
        }

        terminal.repaint();
        Ok(())
    }

    pub(crate) fn handle_resize(
        terminal: &mut Terminal,
        last_width: &mut u16,
        last_height: &mut u16,
        new_width: u16,
        new_height: u16,
    ) {
        use crossterm::cursor::MoveTo;
        use crossterm::execute;
        use crossterm::terminal::{Clear, ClearType};
        use std::io::stdout;

        if new_width != *last_width || new_height != *last_height {
            if terminal.is_alt_screen() {
                let _ = execute!(stdout(), MoveTo(0, 0), Clear(ClearType::All));
            }
            // Inline mode: repaint only to avoid clearing scrollback.
            terminal.repaint();
        }

        *last_width = new_width;
        *last_height = new_height;
    }
}