tui-canvas 0.8.10

Form/textarea/input for TUI
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

// src/canvas/theme.rs

#[cfg(feature = "gui")]
use ratatui::style::{Color, Modifier, Style};

/// Theme trait that must be implemented by applications using the canvas GUI.
///
/// Each method returns a [`Style`] that captures the full visual intent for a
/// specific UI role (foreground, background, modifiers). This allows Helix
/// theme scopes to be mapped directly without losing information.
#[cfg(feature = "gui")]
pub trait CanvasTheme {
    /// Background fill for the canvas surface and dropdown panels.
    fn background(&self) -> Style;
    /// Field labels rendered beside each input.
    fn label(&self) -> Style;
    /// Field label for the row containing the primary cursor.
    fn label_active(&self) -> Style;
    /// Non-active input field text.
    fn input(&self) -> Style;
    /// Active (focused) input field text.
    fn input_active(&self) -> Style;
    /// Text selection highlight (characterwise and linewise).
    fn selection(&self) -> Style;
    /// Background for the row containing the primary cursor.
    fn cursorline(&self) -> Style;
    /// Inline completion / ghost text shown after the cursor.
    fn completion(&self) -> Style;
    /// Cursor cell in normal/navigation mode.
    fn cursor_normal(&self) -> Style;
    /// Cursor cell in insert mode.
    fn cursor_insert(&self) -> Style;
    /// Cursor cell in selection mode.
    fn cursor_select(&self) -> Style;
    /// Non-selected suggestions dropdown items.
    fn suggestions(&self) -> Style;
    /// Selected / highlighted suggestion in the dropdown.
    fn suggestion_selected(&self) -> Style;
    /// Warning-style emphasis for validation errors, etc.
    ///
    /// Reserved for future use; not yet consumed by tui-canvas render
    /// code. Implementors should map this to a suitable Helix scope
    /// (e.g. `warning` / `diagnostic.warning`).
    fn warning(&self) -> Style;
    /// Inactive border style.
    ///
    /// Reserved for future use; not yet consumed by tui-canvas render
    /// code. Implementors should map this to a suitable Helix scope
    /// (e.g. `ui.window`).
    fn border(&self) -> Style;
    /// Active / focused border style.
    ///
    /// Reserved for future use; not yet consumed by tui-canvas render
    /// code. Implementors should map this to a suitable Helix scope
    /// (e.g. `ui.cursor.primary.normal` / `ui.text.focus`).
    fn border_active(&self) -> Style;
}

#[cfg(feature = "gui")]
#[derive(Debug, Clone, Default)]
pub struct DefaultCanvasTheme;

#[cfg(feature = "gui")]
impl CanvasTheme for DefaultCanvasTheme {
    fn background(&self) -> Style {
        Style::default().bg(Color::Black)
    }
    fn label(&self) -> Style {
        Style::default().fg(Color::White)
    }
    fn label_active(&self) -> Style {
        Style::default().fg(Color::Yellow)
    }
    fn input(&self) -> Style {
        Style::default().fg(Color::White)
    }
    fn input_active(&self) -> Style {
        Style::default().fg(Color::White)
    }
    fn selection(&self) -> Style {
        Style::default()
            .fg(Color::Yellow)
            .bg(Color::Blue)
            .add_modifier(Modifier::BOLD)
    }
    fn cursorline(&self) -> Style {
        Style::default().bg(Color::DarkGray)
    }
    fn completion(&self) -> Style {
        Style::default().fg(Color::DarkGray)
    }
    fn cursor_normal(&self) -> Style {
        Style::default().fg(Color::Black).bg(Color::White)
    }
    fn cursor_insert(&self) -> Style {
        Style::default().fg(Color::Black).bg(Color::Green)
    }
    fn cursor_select(&self) -> Style {
        Style::default().fg(Color::Black).bg(Color::Blue)
    }
    fn suggestions(&self) -> Style {
        Style::default().fg(Color::White).bg(Color::Black)
    }
    fn suggestion_selected(&self) -> Style {
        Style::default()
            .fg(Color::Black)
            .bg(Color::Yellow)
            .add_modifier(Modifier::BOLD)
    }
    fn warning(&self) -> Style {
        Style::default().fg(Color::Red)
    }
    fn border(&self) -> Style {
        Style::default().fg(Color::DarkGray)
    }
    fn border_active(&self) -> Style {
        Style::default().fg(Color::Cyan)
    }
}