Struct TextInput 

pub struct TextInput { /* private fields */ }

A focusable single-line (or multi-line) text field backed by a real String buffer. Keyboard input is handled via key events (key_char + editing keys), so typed characters genuinely appear and backspace deletes.

This is a stateful view: create with cx.new(|cx| TextInput::new(cx)) and store the resulting Entity<TextInput>.

Implementations

impl TextInput

pub fn new(cx: &mut App) -> Self

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

pub fn multiline(self, multiline: bool) -> Self

pub fn read_only(self, read_only: bool) -> Self

When true, the input no longer accepts keyboard edits (used for read-only code previews). Focus/selection styling is unaffected.

pub fn invalid(self, invalid: bool) -> Self

Sets the error validation state (red border/ring) when invalid is true, otherwise clears back to InputValidationState::Neutral.

pub fn success(self, success: bool) -> Self

Sets the success validation state (green border/ring) when success is true, otherwise clears back to InputValidationState::Neutral.

pub fn warning(self, warning: bool) -> Self

Sets the warning validation state (amber border/ring) when warning is true, otherwise clears back to InputValidationState::Neutral.

pub fn text(&self) -> &str

The current text content.

pub fn set_text(&mut self, text: impl Into<String>, cx: &mut Context<'_, Self>)

Programmatically sets the text content (e.g. SearchInput/Combobox setting the display text after a selection). Notifies for re-render.

pub fn clear(&mut self, cx: &mut Context<'_, Self>)

Clears the text content (e.g. SearchInput’s clear button). Notifies for re-render.

pub fn set_read_only(&mut self, read_only: bool, cx: &mut Context<'_, Self>)

Dynamically toggles read-only mode after construction (e.g. CodeEditor switching an already-created input between editable and preview modes). Notifies for re-render.

Trait Implementations

impl Focusable for TextInput

fn focus_handle(&self, _cx: &App) -> FocusHandle

Returns the focus handle associated with this view.

impl Render for TextInput

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.