pub struct TextInput { /* private fields */ }Expand description
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§
Source§impl TextInput
impl TextInput
Sourcepub fn placeholder(self, text: impl IntoProp<String>) -> TextInput
pub fn placeholder(self, text: impl IntoProp<String>) -> TextInput
Sets the text shown, dimmed, while the field is empty.
Sourcepub fn password(self, password: impl IntoProp<bool>) -> TextInput
pub fn password(self, password: impl IntoProp<bool>) -> TextInput
Sets whether the field shows a dot for each character instead of the text.
Sourcepub fn focus(self, focus: impl IntoProp<bool>) -> TextInput
pub fn focus(self, focus: impl IntoProp<bool>) -> TextInput
Takes the keyboard focus whenever this turns true, as when a launcher opens.
Sourcepub fn on_accept(self, handler: impl Fn(&Cx, &str) + 'static) -> TextInput
pub fn on_accept(self, handler: impl Fn(&Cx, &str) + 'static) -> TextInput
Runs handler with the text when Enter is pressed in the field.
Sourcepub fn style(self, style: impl IntoProp<Style>) -> TextInput
pub fn style(self, style: impl IntoProp<Style>) -> TextInput
Sets the style. A field cuts its text to the inside of its border.
Its text takes the font, color, alignment, line height and
decorations it inherits or sets, as a Text does.
Sourcepub fn visible(self, visible: impl IntoProp<bool>) -> Self
pub fn visible(self, visible: impl IntoProp<bool>) -> Self
Shows or hides the widget. Hidden, it is taken out of the layout, so its space goes to the others, and it isn’t drawn, hit or reached by Tab; it drops the keyboard focus and the pointer. Its bindings and state stay, so it shows again as it was. Shown by default.
Sourcepub fn geometry(self, geometry: Signal<Rect>) -> Self
pub fn geometry(self, geometry: Signal<Rect>) -> Self
Shares where the widget is: after each layout that moves or
resizes it, its laid-out rectangle in the window’s logical
pixels, scrolled with any scroll view around it but not moved by
a style’s translate, scale or rotate, is written to geometry. A
hidden widget writes nothing. An effect that reads it may change
the layout: the window is laid out again at once, until nothing
moves.
Sourcepub fn mapped_geometry(self, geometry: Signal<Rect>) -> Self
pub fn mapped_geometry(self, geometry: Signal<Rect>) -> Self
Shares where the widget is drawn: the box around it once its own and its ancestors’ translate, scale and rotate have moved it, in the window’s logical pixels, scrolled with any scroll view around it. It is written after each layout that moves it and after each change of a transform or an offset that does, every frame of an animated one. A hidden widget writes nothing. Where the window itself is on its output is unknown: Wayland doesn’t tell a client.
Sourcepub fn accessible_name(self, name: impl IntoProp<String>) -> Self
pub fn accessible_name(self, name: impl IntoProp<String>) -> Self
What a screen reader calls the widget, instead of what it shows: a button’s text, a text’s own, or a field’s placeholder. An icon button needs one to be read at all.