ratatui-form 0.1.1

A Rust TUI form builder crate built on 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
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

//! Checkbox field.

use crossterm::event::{KeyCode, KeyEvent};
use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use ratatui::text::{Line, Span};
use ratatui::widgets::Widget;
use serde_json::Value;
use unicode_width::UnicodeWidthStr;

use crate::field::Field;
use crate::style::FormStyle;
use crate::validation::ValidationError;

/// A checkbox field.
pub struct Checkbox {
    id: String,
    label: String,
    checked: bool,
    required: bool,
}

impl Checkbox {
    /// Creates a new checkbox field.
    pub fn new(id: impl Into<String>, label: impl Into<String>) -> Self {
        Self {
            id: id.into(),
            label: label.into(),
            checked: false,
            required: false,
        }
    }

    /// Sets the initial checked state.
    pub fn checked(mut self, checked: bool) -> Self {
        self.checked = checked;
        self
    }

    /// Marks this field as required (must be checked).
    pub fn required(mut self) -> Self {
        self.required = true;
        self
    }

    fn toggle(&mut self) {
        self.checked = !self.checked;
    }
}

impl Field for Checkbox {
    fn id(&self) -> &str {
        &self.id
    }

    fn label(&self) -> &str {
        &self.label
    }

    fn render(&self, area: Rect, buf: &mut Buffer, focused: bool, style: &FormStyle) {
        if area.height < 1 || area.width < 4 {
            return;
        }

        let checkbox_style = if focused {
            style.input_focused
        } else {
            style.input
        };

        let label_style = if focused {
            style.label_focused
        } else {
            style.label
        };

        // Render checkbox
        let checkbox_char = if self.checked { "[✓]" } else { "[ ]" };
        for (i, c) in checkbox_char.chars().enumerate() {
            if area.x + (i as u16) < area.x + area.width {
                buf[(area.x + i as u16, area.y)].set_char(c);
                buf[(area.x + i as u16, area.y)].set_style(checkbox_style);
            }
        }

        // Render label
        let required_marker = if self.required { "*" } else { "" };
        let label_text = format!(" {}{}", self.label, required_marker);
        let label_x = area.x + 3;
        let remaining_width = area.width.saturating_sub(3);

        if remaining_width > 0 {
            let label_span = Span::styled(&label_text, label_style);
            let label_line = Line::from(label_span);
            let label_area = Rect {
                x: label_x,
                y: area.y,
                width: remaining_width.min(label_text.width() as u16),
                height: 1,
            };
            label_line.render(label_area, buf);
        }
    }

    fn handle_input(&mut self, event: &KeyEvent) -> bool {
        match event.code {
            KeyCode::Enter | KeyCode::Char(' ') => {
                self.toggle();
                true
            }
            _ => false,
        }
    }

    fn value(&self) -> Value {
        Value::Bool(self.checked)
    }

    fn validate(&self) -> Result<(), Vec<ValidationError>> {
        if self.required && !self.checked {
            Err(vec![ValidationError {
                field_id: self.id.clone(),
                message: format!("{} must be checked", self.label),
            }])
        } else {
            Ok(())
        }
    }

    fn height(&self) -> u16 {
        1
    }

    fn is_required(&self) -> bool {
        self.required
    }
}