Struct TextInput 

pub struct TextInput { /* private fields */ }

A single-line text input widget.

Implementations

impl TextInput

pub fn new() -> Self

Create a new empty text input.

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

Set the text value (builder).

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

Set the placeholder text (builder).

pub fn with_mask(self, mask: char) -> Self

Set password mode with mask character (builder).

pub fn with_max_length(self, max: usize) -> Self

Set maximum length in graphemes (builder).

pub fn with_style(self, style: Style) -> Self

Set base style (builder).

pub fn with_cursor_style(self, style: Style) -> Self

Set cursor style (builder).

pub fn with_placeholder_style(self, style: Style) -> Self

Set placeholder style (builder).

pub fn with_selection_style(self, style: Style) -> Self

Set selection style (builder).

pub fn with_focused(self, focused: bool) -> Self

Set whether the input is focused (builder).

pub fn value(&self) -> &str

Get the current value.

pub fn set_value(&mut self, value: impl Into<String>)

Set the value, clamping cursor to valid range.

pub fn clear(&mut self)

Clear all text.

pub fn cursor(&self) -> usize

Get the cursor position (grapheme index).

pub fn focused(&self) -> bool

Check if the input is focused.

pub fn set_focused(&mut self, focused: bool)

Set focus state.

pub fn cursor_position(&self, area: Rect) -> (u16, u16)

Get the cursor screen position relative to a render area.

Returns (x, y) where x is the column and y is the row. Useful for Frame::set_cursor().

pub fn selected_text(&self) -> Option<&str>

Get selected text, if any.

pub fn handle_event(&mut self, event: &Event) -> bool

Handle a terminal event.

Returns true if the state changed.

pub fn insert_text(&mut self, text: &str)

Insert text at the current cursor position.

This method:

• Replaces newlines and tabs with spaces.
• Filters out other control characters.
• Respects max_length (truncating if necessary).
• Efficiently inserts the result in one operation.

pub fn select_all(&mut self)

Select all text.

impl TextInput

pub fn create_text_edit_command( &self, operation: TextEditOperation, ) -> Option<WidgetTextEditCmd>

Create an undo command for the given text edit operation.

This creates a command that can be added to a HistoryManager for undo/redo support. The command includes callbacks that will be called when the operation is undone or redone.

Example

let mut input = TextInput::new();
let old_value = input.value().to_string();

// Perform the edit
input.set_value("new text");

// Create undo command
if let Some(cmd) = input.create_text_edit_command(TextEditOperation::SetValue {
    old_value,
    new_value: "new text".to_string(),
}) {
    history.push(cmd);
}

pub fn undo_id(&self) -> UndoWidgetId

Get the undo widget ID.

This can be used to associate undo commands with this widget instance.

Trait Implementations

impl Clone for TextInput

fn clone(&self) -> TextInput

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() -> TextInput

Returns the “default value” for a type.

impl TextInputUndoExt for TextInput

fn text_value(&self) -> &str

Get the current text value.

fn set_text_value(&mut self, value: &str)

Set the text value directly (for undo/redo).

fn cursor_position(&self) -> usize

Get the current cursor position.

fn set_cursor_position(&mut self, pos: usize)

Set the cursor position directly.

fn insert_text_at(&mut self, position: usize, text: &str)

Insert text at a position.

fn delete_text_range(&mut self, start: usize, end: usize)

Delete text at a range.

impl UndoSupport for TextInput

fn undo_widget_id(&self) -> UndoWidgetId

Get the widget’s unique ID for undo tracking.

fn create_snapshot(&self) -> Box<dyn Any + Send>

Create a snapshot of the current state for undo purposes.

fn restore_snapshot(&mut self, snapshot: &dyn Any) -> bool

Restore state from a snapshot.

impl Widget for TextInput

fn render(&self, area: Rect, frame: &mut Frame<'_>)

Render the widget into the frame at the given area.

fn is_essential(&self) -> bool

Whether this widget is essential and should always render.