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. IME composition (e.g. Vietnamese/CJK input methods) is handled via the EntityInputHandler impl, so composed text commits correctly.

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 submit_on_enter(self, submit_on_enter: bool) -> Self

When true, plain Enter fires Self::on_submit instead of inserting a newline; Shift/Ctrl/Cmd+Enter still inserts a newline (in multiline mode). Defaults to false, which preserves the previous behavior of always inserting a newline on Enter in multiline mode (e.g. CodeEditor’s free-form multiline input).

pub fn on_submit( self, handler: impl Fn(&mut Window, &mut Context<'_, Self>) + 'static, ) -> Self

Registers a callback fired when the user presses plain Enter while Self::submit_on_enter is true. Has no effect otherwise.

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 EntityInputHandler for TextInput

fn selected_text_range( &mut self, _ignore_disabled_input: bool, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<UTF16Selection>

No cursor/selection tracking — this is an append-only field. Returning None tells the platform there is no active selection (IME commits at the end).

fn marked_text_range( &self, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<Range<usize>>

The byte range of in-progress IME marked (composition) text.

fn text_for_range( &mut self, range_utf16: Range<usize>, _adjusted_range: &mut Option<Range<usize>>, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<String>

Returns the text in the given UTF-16 range (used by the platform to read back what’s around the composition).

fn replace_text_in_range( &mut self, range: Option<Range<usize>>, text: &str, _window: &mut Window, cx: &mut Context<'_, Self>, )

IME committed text (or a plain paste/insert). Replaces any in-progress marked range, otherwise appends at the end.

fn replace_and_mark_text_in_range( &mut self, range: Option<Range<usize>>, new_text: &str, _new_selected_range: Option<Range<usize>>, _window: &mut Window, cx: &mut Context<'_, Self>, )

IME composition in progress — replace the given range (or append) with new_text and mark it as the active composition range.

fn unmark_text(&mut self, _window: &mut Window, cx: &mut Context<'_, Self>)

Composition finalized/abandoned — drop the mark without changing text.

fn bounds_for_range( &mut self, _range_utf16: Range<usize>, element_bounds: Bounds<Pixels>, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<Bounds<Pixels>>

Bounds for a UTF-16 range within the field, for IME candidate placement. Best-effort: returns the element bounds (candidates appear near the field, not pixel-perfect per-character).

fn accepts_text_input( &self, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> bool

See InputHandler::accepts_text_input for details

fn character_index_for_point( &mut self, _point: Point<Pixels>, _window: &mut Window, _cx: &mut Context<'_, Self>, ) -> Option<usize>

See InputHandler::character_index_for_point for details

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.