tui-lipan 0.2.0

Opinionated, component-based TUI framework for Rust - declarative components, reconciliation, layout engine, focus, overlays, and rich widgets on top of ratatui.
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

use crate::callback::{Callback, KeyHandler};
use crate::style::{
    BorderStyle, CaretShape, Color, Length, Padding, ScrollbarVariant, Span, Style, StyleSlot,
};
use crate::widgets::ScrollEvent;
use std::sync::Arc;

use super::events::{
    MouseModeState, TerminalInputEvent, TerminalKeyModes, TerminalPasteShortcutBehavior,
};
#[cfg(feature = "terminal-images")]
use super::graphics::TerminalImagePlacement;
use super::screen::{TerminalDecoration, TerminalScreenHandle, TerminalViewport};
use super::selection::{TerminalSelection, TerminalSelectionEvent};

/// Terminal-like widget backed by a read-only `TextArea`.
#[derive(Clone)]
pub struct Terminal {
    pub(crate) content: Arc<str>,
    pub(crate) cursor_row: u16,
    pub(crate) cursor_col: u16,
    pub(crate) show_cursor: bool,
    pub(crate) cursor_shape: CaretShape,
    pub(crate) cursor_blinking: bool,
    pub(crate) caret_color: Option<Color>,
    pub(crate) color_lines: Option<Arc<[Vec<Span>]>>,
    pub(crate) color_cache_key: u64,
    /// Set by [`Terminal::screen`](super::Terminal::screen): the widget reads this screen itself
    /// instead of being handed a snapshot, so output can repaint without a rebuild.
    pub(crate) screen: Option<TerminalScreenHandle>,
    /// Overlays applied on top of whatever the live screen reports. Only meaningful with `screen`;
    /// a caller passing a snapshot decorates it themselves.
    pub(crate) decorations: Arc<[TerminalDecoration]>,
    pub(crate) scrollback_offset: usize,
    pub(crate) total_scrollback_rows: usize,
    pub(crate) mouse_mode: MouseModeState,
    pub(crate) key_modes: TerminalKeyModes,
    /// Images from a handed-in snapshot. The live-screen path refreshes these per draw
    /// instead, so this stays empty there.
    #[cfg(feature = "terminal-images")]
    pub(crate) images: Arc<[TerminalImagePlacement]>,
    pub(crate) paste_shortcut_behavior: TerminalPasteShortcutBehavior,
    pub(crate) selection: Option<TerminalSelection>,
    pub(crate) selection_controlled: bool,
    pub(crate) selection_style: StyleSlot,
    pub(crate) on_selection: Option<Callback<TerminalSelectionEvent>>,
    pub(crate) on_resize: Option<Callback<TerminalViewport>>,
    pub(crate) on_mouse_forward: Option<Callback<Vec<u8>>>,
    pub(crate) scroll_wheel: bool,
    pub(crate) on_scroll: Option<Callback<ScrollEvent>>,
    pub(crate) on_scroll_to: Option<Callback<usize>>,
    pub(crate) style: Style,
    pub(crate) hover_style: StyleSlot,
    pub(crate) focus_style: StyleSlot,
    pub(crate) focus_content_style: Style,
    pub(crate) border: bool,
    pub(crate) border_style: BorderStyle,
    pub(crate) padding: Padding,
    pub(crate) scrollbar: bool,
    pub(crate) scrollbar_variant: ScrollbarVariant,
    pub(crate) scrollbar_gap: u16,
    pub(crate) scrollbar_thumb: Option<char>,
    pub(crate) scrollbar_thumb_style: Option<Style>,
    pub(crate) scrollbar_thumb_focus_style: Option<Style>,
    pub(crate) scrollbar_track_style: Option<Style>,
    pub(crate) h_scrollbar: bool,
    pub(crate) h_scrollbar_variant: ScrollbarVariant,
    pub(crate) width: Length,
    pub(crate) height: Length,
    pub(crate) focusable: bool,
    pub(crate) tab_stop: bool,
    pub(crate) on_focus: Option<Callback<()>>,
    pub(crate) on_blur: Option<Callback<()>>,
    pub(crate) on_key: Option<KeyHandler>,
    pub(crate) on_input: Option<Callback<TerminalInputEvent>>,
}