Struct TextInput 

pub struct TextInput {

    pub err: Option<String>,
    pub prompt: String,
    pub placeholder: String,
    pub echo_mode: EchoMode,
    pub echo_character: char,
    pub cursor: Cursor,
    pub prompt_style: Style,
    pub text_style: Style,
    pub placeholder_style: Style,
    pub completion_style: Style,
    pub char_limit: usize,
    pub width: usize,
    pub key_map: KeyMap,
    pub show_suggestions: bool,
    /* private fields */
}

Single-line text input model.

Fields

err: Option<String>

Current error from validation.

prompt: String

Prompt displayed before input.

placeholder: String

Placeholder text when empty.

echo_mode: EchoMode

Echo mode (normal, password, none).

echo_character: char

Character to display in password mode.

cursor: Cursor

Cursor model.

prompt_style: Style

Style for the prompt.

text_style: Style

Style for the text.

placeholder_style: Style

Style for the placeholder.

completion_style: Style

Style for completions.

char_limit: usize

Maximum characters allowed (0 = no limit).

width: usize

Maximum display width (0 = no limit).

key_map: KeyMap

Key bindings.

show_suggestions: bool

Whether to show suggestions.

Implementations

impl TextInput

pub fn new() -> Self

Creates a new text input with default settings.

pub fn set_prompt(&mut self, prompt: impl Into<String>)

Sets the prompt string.

pub fn set_placeholder(&mut self, placeholder: impl Into<String>)

Sets the placeholder text.

pub fn set_echo_mode(&mut self, mode: EchoMode)

Sets the echo mode.

pub fn set_value(&mut self, s: &str)

Sets the value of the text input.

pub fn value(&self) -> String

Returns the current value as a string.

pub fn position(&self) -> usize

Returns the cursor position.

pub fn set_cursor(&mut self, pos: usize)

Sets the cursor position.

pub fn cursor_start(&mut self)

Moves cursor to start of input.

pub fn cursor_end(&mut self)

Moves cursor to end of input.

pub fn focused(&self) -> bool

Returns whether the input is focused.

pub fn focus(&mut self) -> Option<Cmd>

Focuses the input and returns the cursor blink command.

pub fn blur(&mut self)

Blurs the input.

pub fn reset(&mut self)

Resets the input to empty.

pub fn set_suggestions(&mut self, suggestions: &[&str])

Sets the suggestions list.

pub fn set_validate<F>(&mut self, f: F)

where F: Fn(&str) -> Option<String> + Send + Sync + 'static,

Sets the validation function.

pub fn available_suggestions(&self) -> Vec<String>

Returns available suggestions as strings.

pub fn matched_suggestions(&self) -> Vec<String>

Returns matched suggestions as strings.

pub fn current_suggestion_index(&self) -> usize

Returns the current suggestion index.

pub fn current_suggestion(&self) -> String

Returns the current suggestion.

pub fn update(&mut self, msg: Message) -> Option<Cmd>

Updates the text input based on messages.

pub fn view(&self) -> String

Renders the text input.

Trait Implementations

impl Clone for TextInput

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for TextInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for TextInput

fn default() -> Self

Returns the “default value” for a type.

impl Model for TextInput

fn init(&self) -> Option<Cmd>

Initialize the text input.

If focused and cursor is in blink mode, returns a blink command.

fn update(&mut self, msg: Message) -> Option<Cmd>

Update the text input state based on incoming messages.

Handles:

• KeyMsg - Keyboard input for text entry and navigation
• PasteMsg - Paste operations
• Cursor blink messages

fn view(&self) -> String

Render the text input.