Struct TextInput 

pub struct TextInput {

    pub id: Option<NodeId>,
    pub value: String,
    pub placeholder: Option<TextContent>,
    pub on_change: Option<ActionEnvelope>,
    pub width: Option<f32>,
    pub height: Option<f32>,
    pub multiline: bool,
    pub min_lines: Option<usize>,
    pub max_lines: Option<usize>,
    pub obscure_text: bool,
    pub obscuring_character: char,
    pub mask: Option<InputMask>,
    pub styled_runs: Option<Vec<TextRun>>,
    pub borderless: bool,
    pub capture_tab: bool,
    pub auto_indent: bool,
    pub on_cursor_change: Option<ActionEnvelope>,
    pub highlight_ranges: Vec<(usize, usize, Color)>,
}

An editable text field with support for single-line and multiline input, syntax highlighting, password masking, and IME composition.

TextInput is the primary text-editing widget. It manages its own scroll container, caret, selection, and (when styled_runs is provided) multi-colour syntax-highlighted rendering.

Example

let on_change = ctx.bind(TextChanged { .. }, handle_text as fn(&mut S, TextChanged));

TextInput {
    value: view.state.query.clone(),
    placeholder: Some("Search...".into()),
    on_change: Some(on_change),
    ..Default::default()
}

Code editor mode

For embedding in a code editor, enable borderless, capture_tab, auto_indent, and provide styled_runs for syntax highlighting:

TextInput {
    value: source_code.clone(),
    multiline: true,
    borderless: true,
    capture_tab: true,
    auto_indent: true,
    styled_runs: Some(highlighted_runs),
    ..Default::default()
}

Fields

id: Option<NodeId>

Explicit node identity (used for focus tracking and scroll state).

value: String

The current text value (controlled by the application).

placeholder: Option<TextContent>

Placeholder text shown when value is empty.

on_change: Option<ActionEnvelope>

Action dispatched when the text changes.

width: Option<f32>

Fixed width in layout points.

height: Option<f32>

Fixed height in layout points.

multiline: bool

When true, the input accepts newlines and scrolls vertically.

min_lines: Option<usize>

Minimum number of visible lines (multiline only).

max_lines: Option<usize>

Maximum number of visible lines (multiline only).

obscure_text: bool

When true, display each grapheme as obscuring_character (password mode).

obscuring_character: char

The character used when obscure_text is true (default: '•').

mask: Option<InputMask>

Structural input mask (e.g. phone number, date).

styled_runs: Option<Vec<TextRun>>

Pre-styled text runs for syntax highlighting.

When provided and no selection is active, these runs are rendered instead of the default single-colour text. The concatenated text of all runs must match value exactly.

borderless: bool

When true, the background rect and border are omitted (for embedding in editor chrome).

capture_tab: bool

When true, the Tab key inserts whitespace instead of moving focus.

auto_indent: bool

When true, pressing Enter copies the leading whitespace of the current line (auto-indentation).

on_cursor_change: Option<ActionEnvelope>

Action dispatched when the caret or selection anchor changes.

highlight_ranges: Vec<(usize, usize, Color)>

Ranges to highlight in the text (e.g. find-match results).

Each entry is (start_byte, end_byte, background_color).

Implementations

impl TextInput

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

pub fn into_node(self) -> Node

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

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TextInput

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<TextInput> for Node

fn from(w: TextInput) -> Self

Converts to this type from the input type.

impl Lower for TextInput

fn lower(&self, cx: &mut LoweringContext<'_>) -> NodeId

Lower this widget into the IR, returning the root node id.

impl Serialize for TextInput

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<S: AppState> Widget<S> for TextInput

fn build(&self, _ctx: &mut BuildCtx<S>, _view: &View<'_, S>) -> Node

Build the widget’s node tree.