Struct TextInput 

pub struct TextInput { /* private fields */ }

A one-line text field. It takes the keyboard focus when clicked, when Tab reaches it, or when focus says so, and edits the text in a shared signal: typing writes it, and setting it changes what the field shows. Arrows, Home and End move the caret, Shift selects, Ctrl moves and deletes by word, and Ctrl+A selects everything. Keys it doesn’t use, such as Up, Down and Escape, go on to the window’s on_key.

use crabshell_ui::{Cx, TextInput};

fn search(cx: &Cx) -> TextInput {
    let query = cx.signal(String::new());
    TextInput::new(query)
        .placeholder("Search")
        .on_accept(|_cx, text| println!("run {text}"))
}

Implementations

impl TextInput

pub fn new(text: Signal<String>) -> TextInput

A field editing text.

pub fn placeholder(self, text: impl IntoProp<String>) -> TextInput

Sets the text shown, dimmed, while the field is empty.

pub fn password(self, password: impl IntoProp<bool>) -> TextInput

Sets whether the field shows a dot for each character instead of the text.

pub fn focus(self, focus: impl IntoProp<bool>) -> TextInput

Takes the keyboard focus whenever this turns true, as when a launcher opens.

pub fn on_accept(self, handler: impl Fn(&Cx, &str) + 'static) -> TextInput

Runs handler with the text when Enter is pressed in the field.

pub fn style(self, style: impl IntoProp<Style>) -> TextInput

Sets the style. A field cuts its text to the inside of its border.

Trait Implementations

impl Widget for TextInput

fn into_element(self: Box<Self>) -> Element

Turns the description, and everything inside it, into the element the window builds nodes from. It runs when the window is created or a list item first appears, before the window’s tree is touched and without recording what it reads, so it only describes.