Struct TextInput 

pub struct TextInput { /* private fields */ }

A single-line text input field.

Implementations

impl TextInput

pub fn new(id: impl Into<String>, label: impl Into<String>) -> Self

Creates a new text input field.

pub fn placeholder(self, placeholder: impl Into<String>) -> Self

Sets a placeholder text.

pub fn required(self) -> Self

Marks this field as required.

pub fn validator(self, validator: Box<dyn Validator>) -> Self

Adds a validator to this field.

pub fn initial_value(self, value: impl Into<String>) -> Self

Sets the initial value.

Trait Implementations

impl Field for TextInput

fn id(&self) -> &str

Returns the unique identifier for this field.

fn label(&self) -> &str

Returns the display label for this field.

fn render(&self, area: Rect, buf: &mut Buffer, focused: bool, style: &FormStyle)

Renders the field to the buffer.

fn handle_input(&mut self, event: &KeyEvent) -> bool

Handles keyboard input. Returns true if the input was consumed.

fn value(&self) -> Value

Returns the current value as a JSON value.

fn validate(&self) -> Result<(), Vec<ValidationError>>

Validates the field and returns any errors.

fn height(&self) -> u16

Returns the height needed to render this field.

fn is_required(&self) -> bool

Returns whether this field is required.