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

//! Field types for form inputs.

mod text;
mod select;
mod checkbox;

pub use text::TextInput;
pub use select::Select;
pub use checkbox::Checkbox;

use crossterm::event::KeyEvent;
use ratatui::buffer::Buffer;
use ratatui::layout::Rect;
use serde_json::Value;

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

/// Trait for form fields.
pub trait Field: Send + Sync {
    /// Returns the unique identifier for this field.
    fn id(&self) -> &str;

    /// Returns the display label for this field.
    fn label(&self) -> &str;

    /// Renders the field to the buffer.
    fn render(&self, area: Rect, buf: &mut Buffer, focused: bool, style: &FormStyle);

    /// Handles keyboard input. Returns true if the input was consumed.
    fn handle_input(&mut self, event: &KeyEvent) -> bool;

    /// Returns the current value as a JSON value.
    fn value(&self) -> Value;

    /// Validates the field and returns any errors.
    fn validate(&self) -> Result<(), Vec<ValidationError>>;

    /// Returns the height needed to render this field.
    fn height(&self) -> u16 {
        1
    }

    /// Returns whether this field is required.
    fn is_required(&self) -> bool {
        false
    }
}