Struct TextInput 

pub struct TextInput { /* private fields */ }

A single-line text field. Create with cx.new(|cx| TextInput::new(cx)).

Implementations

impl TextInput

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

pub fn value(self, value: &str) -> Self

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

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

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

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

pub fn size(self, size: Size) -> Self

pub fn radius(self, radius: Size) -> Self

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

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

Selectable and copyable, but not editable — an <input readonly>. Unlike disabled the field still takes focus.

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

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

Cap the value’s length in characters, like <input maxlength>.

pub fn text(&self) -> String

The current text.

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

Replace the text programmatically.

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

Select the whole value, as focusing a field with <input autofocus> and a preset value tends to.

pub fn bind(entity: &Entity<TextInput>, signal: &Signal<String>, cx: &mut App)

Two-way bind the text to a Signal<String>. The signal is the source of truth: the field adopts its value now, edits write back through Signal::set_if_changed, and signal writes replace the text without emitting. Equality guards on both directions prevent update loops.

impl TextInput

pub fn tab_index(self, index: isize) -> Self

Where this field sits in the window’s Tab order. Fields default to 0, which walks them in render order; set this only to override that.

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

Leave the field out of the Tab order without disabling it.

pub fn focus_handle(&self) -> FocusHandle

The field’s focus handle, so a host can focus it on open.

Trait Implementations

impl EntityInputHandler for TextInput

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

See InputHandler::text_for_range for details

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

See InputHandler::selected_text_range for details

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

See InputHandler::marked_text_range for details

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

See InputHandler::unmark_text for details

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

See InputHandler::replace_text_in_range for details

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

See InputHandler::replace_and_mark_text_in_range for details

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

See InputHandler::bounds_for_range 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 EventEmitter<TextInputEvent> for TextInput

impl LineEditor for TextInput

fn edit(&self) -> &TextEdit

fn edit_mut(&mut self) -> &mut TextEdit

fn line(&self) -> &LineState

fn line_mut(&mut self) -> &mut LineState

fn line_focus(&self) -> &FocusHandle

fn line_masked(&self) -> bool

Show bullets instead of characters, and refuse to copy or cut.

fn line_read_only(&self) -> bool

Accept focus, selection, and copy, but reject every mutation.

fn line_max_length(&self) -> Option<usize>

Cap on the value’s length in chars, enforced on typing and on paste the way an <input maxlength> is.

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

Called after any mutation so the field can emit its change event. The element never calls cx.notify on the host’s behalf; do it here.

fn line_filter(&self, text: String) -> String

Narrow what may be entered, the way <input type="number"> does. Returns the text to actually insert; dropping every char rejects the input. Applied to typing, IME, drops, and paste alike, so a field can’t be filled with something it rejects by any route.

impl Render for TextInput

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

Render this view into an element tree.