pub struct TextInput<A = ()> { /* private fields */ }Expand description
Editable text field with focus, selection, IME, scrolling, and buffer backing.
The default mode is single-line; Self::multiline enables word-or-anywhere
wrapping and two-axis caret reveal. The widget is always focusable and must
be attached to a writable [Signal<String>] with Self::bind. External
signal changes take precedence and are synchronized into the edit buffer on
the next edit. Placeholder bindings never become the editable value.
Single-line inputs accept native horizontal wheel deltas and Shift plus a
vertical wheel delta. Multiline inputs expose an interactive overlay thumb
that supports centered track clicks and captured dragging without moving the caret or
invoking the change callback.
§Panics
Converting the builder into a view panics if Self::bind was not called.
§Examples
use std::{cell::RefCell, rc::Rc};
use ailloli_ui_runtime::component::Signal;
use ailloli_ui_widgets::controls::TextInput;
let value = Signal::new(Rc::new(RefCell::new(String::new())), Rc::new(|| {}));
let input: TextInput<()> = TextInput::new().bind(value).placeholder("Name");
let _ = input;Implementations§
Source§impl<A: 'static> TextInput<A>
impl<A: 'static> TextInput<A>
Sourcepub fn height(self, value: impl Into<Length>) -> Self
pub fn height(self, value: impl Into<Length>) -> Self
Sets preferred height from a logical-pixel or length value.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().height(40.0);
let _ = widget;Sourcepub fn min_width(self, value: impl Into<Length>) -> Self
pub fn min_width(self, value: impl Into<Length>) -> Self
Sets the minimum width bound.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_width(40.0);
let _ = widget;Sourcepub fn max_width(self, value: impl Into<Length>) -> Self
pub fn max_width(self, value: impl Into<Length>) -> Self
Sets the maximum width bound.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_width(320.0);
let _ = widget;Sourcepub fn min_height(self, value: impl Into<Length>) -> Self
pub fn min_height(self, value: impl Into<Length>) -> Self
Sets the minimum height bound.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().min_height(24.0);
let _ = widget;Sourcepub fn max_height(self, value: impl Into<Length>) -> Self
pub fn max_height(self, value: impl Into<Length>) -> Self
Sets the maximum height bound.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().max_height(240.0);
let _ = widget;Sourcepub fn fill(self) -> Self
pub fn fill(self) -> Self
Sets both preferred axes to parent fill.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill();
let _ = widget;Sourcepub fn fill_width(self) -> Self
pub fn fill_width(self) -> Self
Sets preferred width to parent fill.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_width();
let _ = widget;Sourcepub fn fill_height(self) -> Self
pub fn fill_height(self) -> Self
Sets preferred height to parent fill.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().fill_height();
let _ = widget;Sourcepub fn margin(self, value: f32) -> Self
pub fn margin(self, value: f32) -> Self
Sets uniform outer margin in logical pixels.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().margin(8.0);
let _ = widget;Sourcepub fn padding(self, value: f32) -> Self
pub fn padding(self, value: f32) -> Self
Sets uniform inner padding in logical pixels.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().padding(8.0);
let _ = widget;Sourcepub fn flex_grow(self) -> Self
pub fn flex_grow(self) -> Self
Sets flex-grow weight to one.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow();
let _ = widget;Sourcepub fn flex_grow_by(self, value: f32) -> Self
pub fn flex_grow_by(self, value: f32) -> Self
Sets a dimensionless flex-grow weight.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_grow_by(2.0);
let _ = widget;Sourcepub fn flex_shrink(self, value: f32) -> Self
pub fn flex_shrink(self, value: f32) -> Self
Sets a dimensionless flex-shrink weight.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_shrink(1.0);
let _ = widget;Sourcepub fn flex_basis(self, value: impl Into<Length>) -> Self
pub fn flex_basis(self, value: impl Into<Length>) -> Self
Sets the preferred main-axis flex basis.
§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().flex_basis(80.0);
let _ = widget;Sourcepub fn align_self(self, value: AlignItems) -> Self
pub fn align_self(self, value: AlignItems) -> Self
Overrides cross-axis alignment for this flex item.
§Examples
use ailloli_ui_core::style::AlignItems;
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().align_self(AlignItems::Center);
let _ = widget;Source§impl<A: 'static> TextInput<A>
impl<A: 'static> TextInput<A>
Sourcepub fn new() -> Self
pub fn new() -> Self
Creates an unbound, single-line input with the default style.
The builder cannot become a view until Self::bind supplies its value.
§Examples
use ailloli_ui_widgets::controls::TextInput;
let input: TextInput<()> = TextInput::new();
let _ = input; // bind before converting into a viewSourcepub fn bind(self, value: impl Into<Signal<String>>) -> Self
pub fn bind(self, value: impl Into<Signal<String>>) -> Self
Sets the required writable string signal, replacing any previous one.
User edits update both the persistent [TextBuffer] and this signal
before the optional change callback runs.
§Examples
use std::{cell::RefCell, rc::Rc};
use ailloli_ui_runtime::component::Signal;
use ailloli_ui_widgets::controls::TextInput;
let value = Signal::new(Rc::new(RefCell::new("Ada".to_string())), Rc::new(|| {}));
let input: TextInput<()> = TextInput::new().bind(value);
let _ = input;Sourcepub fn placeholder(self, placeholder: impl Into<Binding<String>>) -> Self
pub fn placeholder(self, placeholder: impl Into<Binding<String>>) -> Self
Sets static or reactive placeholder text.
It is displayed only when both the bound value and active IME preedit are empty. An empty placeholder remains present but paints no glyphs.
§Examples
use ailloli_ui_widgets::controls::TextInput;
let input: TextInput<()> = TextInput::new().placeholder("Search");
let _ = input;Sourcepub fn size(self, size: f32) -> Self
pub fn size(self, size: f32) -> Self
Sets text size from a floating logical-pixel value.
The value is rounded, clamped to at least 1, then saturated to u16;
NaN and negative infinity therefore become 1, while positive
infinity becomes u16::MAX.
§Examples
use ailloli_ui_widgets::controls::TextInput;
let input: TextInput<()> = TextInput::new().size(15.6);
let _ = input; // resolved text size is 16 logical pixelsSourcepub fn font_family(self, font: FontId) -> Self
pub fn font_family(self, font: FontId) -> Self
Replaces only the editable text font identifier.
§Examples
use ailloli_ui_core::FontId;
use ailloli_ui_widgets::controls::TextInput;
let input: TextInput<()> = TextInput::new().font_family(FontId::Ui);
let _ = input;Sourcepub fn text_style(self, style: TextStyle) -> Self
pub fn text_style(self, style: TextStyle) -> Self
Replaces the complete editable text style.
Placeholder and selection colors remain in TextInputStyle.
§Examples
use ailloli_ui_core::{Color, FontId, TextStyle};
use ailloli_ui_widgets::controls::TextInput;
let input: TextInput<()> =
TextInput::new().text_style(TextStyle::new(FontId::Ui, 16, Color::WHITE));
let _ = input;Sourcepub fn input_style(self, style: TextInputStyle) -> Self
pub fn input_style(self, style: TextInputStyle) -> Self
Replaces every paint, spacing, typography, and caret style value.
§Examples
use ailloli_ui_widgets::controls::{TextInput, TextInputStyle};
let input: TextInput<()> = TextInput::new().input_style(TextInputStyle::default());
let _ = input;Sourcepub fn multiline(self) -> Self
pub fn multiline(self) -> Self
Enables multi-line key handling, wrapping, scrolling, and IME geometry.
The builder has no inverse; create a new input to return to single-line mode. Height remains layout-driven and may grow from wrapped content.
§Examples
use ailloli_ui_widgets::controls::TextInput;
let input: TextInput<()> = TextInput::new().multiline();
let _ = input;Sourcepub fn on_change(self, f: impl Fn(String) -> A + 'static) -> Self
pub fn on_change(self, f: impl Fn(String) -> A + 'static) -> Self
Maps each changed complete value to an application action and dispatches it.
The callback is not invoked for selection, caret, scrolling, or preedit-only changes. A later change-handler builder replaces it.
§Examples
use ailloli_ui_widgets::controls::TextInput;
enum Action { Changed(String) }
let input = TextInput::new().on_change(Action::Changed);
let _ = input;Sourcepub fn on_change_ctx(
self,
f: impl Fn(&mut EventCtx<A>, String) + 'static,
) -> Self
pub fn on_change_ctx( self, f: impl Fn(&mut EventCtx<A>, String) + 'static, ) -> Self
Installs a context-aware callback for changed complete values.
A later change-handler builder replaces it.
§Examples
use ailloli_ui_widgets::controls::TextInput;
let input = TextInput::<()>::new().on_change_ctx(|ctx, _value| ctx.request_repaint());
let _ = input;