Struct TextInput 

pub struct TextInput {
    pub select_on_focus: bool,
    /* private fields */
}

Text input widget state

Fields

select_on_focus: bool

Whether to select all text when focused

Implementations

impl TextInput

pub fn new(cx: &mut Context<'_, Self>) -> Self

Create a new text input

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

Set placeholder text (builder pattern)

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

Set initial value (builder pattern)

pub fn theme(self, theme: Theme) -> Self

Set custom theme (builder pattern)

pub fn select_on_focus(self, select: bool) -> Self

Set select on focus (builder pattern)

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

Set masked mode for password input (builder pattern)

When masked, the input displays bullet characters instead of the actual text, while retaining full editing functionality (cursor movement, selection, etc.)

pub fn is_masked(&self) -> bool

Check if this input is in masked mode

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

Set masked mode programmatically

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

Set borderless mode for embedding in other controls (builder pattern)

When borderless, the input renders without its own border, background, and rounded corners, allowing it to be embedded in unified containers.

pub fn input_filter(self, filter: impl Fn(char) -> bool + 'static) -> Self

Set an input filter to restrict allowed characters (builder pattern)

The filter function receives each character and should return true to allow it. Characters that fail the filter are silently dropped during typing and pasting.

Example

TextInput::new(cx)
    .input_filter(|c| c.is_ascii_digit() || c == '.' || c == '-')

pub fn emit_tab_events(self, emit: bool) -> Self

Emit Tab/ShiftTab events instead of handling focus navigation (builder pattern)

When true, pressing Tab or Shift+Tab emits TextInputEvent::Tab or TextInputEvent::ShiftTab respectively, allowing the parent to handle focus navigation. This is useful when embedding TextInput in other controls that need to intercept Tab for custom behavior.

When false (default), Tab/Shift+Tab directly calls window.focus_next() or window.focus_prev().

pub fn with_enabled(self, enabled: bool) -> Self

Set enabled state (builder pattern)

When disabled, the input does not accept focus, keyboard input, or mouse interaction, and renders with disabled styling.

pub fn is_enabled(&self) -> bool

Check if this input is enabled

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

Set enabled state programmatically

pub fn content(&self) -> &str

Get the current content

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

Set the content value

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

Set placeholder text programmatically

pub fn focus_handle(&self) -> &FocusHandle

Get the focus handle

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.

impl EventEmitter<TextInputEvent> for TextInput