Struct TextInputProps 

pub struct TextInputProps {
    pub value: Bound<String>,
    pub placeholder: Option<String>,
    pub lines: Option<i64>,
    pub title: bool,
    pub enabled: bool,
    pub autofocus: bool,
    pub changed_by: Option<Person>,
    pub previous: Option<String>,
    pub entry: bool,
    pub key: Option<String>,
    pub submit: Event,
}

A field to type text into, bound to the text it edits. Each edit is spliced into that text, never written over it, so people typing in the same text at once all keep what they typed.

Fields

value: Bound<String>

The text it edits.

placeholder: Option<String>

What to type, shown while it is empty.

lines: Option<i64>

Room for this many lines: the field wraps and grows with what is typed.

title: bool

The title of the document the window is for, edited in place as its large title.

enabled: bool

Whether it can be typed into now.

autofocus: bool

It is where the person types next (an entry a command just opened): it takes the keyboard as soon as it is in the window, once.

changed_by: Option<Person>

Someone else changed the text and the person has not seen it yet: the field takes their colour. The host sets it, from what the field is bound to (task-legibility §3).

previous: Option<String>

What the text was before that change, said when the field is hovered.

entry: bool

The entry at the end of a list: what is typed makes an item when Enter or leaving the field commits it, and the field clears; nothing typed leaves nothing (Escape, or leaving it empty). Its own draft, not a record: the item exists once it is committed.

key: Option<String>

The plain key that focuses this control while its window has the keyboard, as the app declared it (key: "Ctrl+N"): a window’s primary action brings the person to the list’s entry rather than making an empty item. Never drawn here.

submit: Event

Enter was pressed: what was typed is done (a list’s entry), carried with it. With it, Enter ends the text rather than breaking its line; Shift+Enter still breaks a wrapping field’s line.

Trait Implementations

impl Component for TextInputProps

const NAME: &'static str = "TextInput"

The component’s name, as code calls it.

fn describe() -> Description

fn from_source(source: &mut dyn Source) -> Result<TextInputProps, Error>

The props source gives.

impl Default for TextInputProps

fn default() -> TextInputProps

Returns the “default value” for a type.