Struct TextInput

Source
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>

Source

pub fn width(self, value: impl Into<Length>) -> Self

Sets preferred width from a logical-pixel or length value.

§Examples
use ailloli_ui_widgets::layout::Container;
let widget: Container<()> = Container::new().width(120.0);
let _ = widget;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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>

Source

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 view
Source

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;
Source

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;
Source

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 pixels
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;
Source

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;

Trait Implementations§

Source§

impl<A: 'static> Default for TextInput<A>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<A: 'static> IntoView<A> for TextInput<A>

Source§

fn into_view(self) -> View<A>

Consumes a builder/value and returns its declarative view tree. Read more
Source§

impl<A: 'static> LayoutExt for TextInput<A>

Source§

fn layout_mut(&mut self) -> &mut LayoutStyle

Returns the widget’s mutable declarative size/inset state. Read more

Auto Trait Implementations§

§

impl<A> Freeze for TextInput<A>

§

impl<A = ()> !RefUnwindSafe for TextInput<A>

§

impl<A = ()> !Send for TextInput<A>

§

impl<A = ()> !Sync for TextInput<A>

§

impl<A> Unpin for TextInput<A>

§

impl<A = ()> !UnwindSafe for TextInput<A>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T, A> FlexItemExt<A> for T
where T: IntoView<A>,

Source§

fn flex_grow(self) -> View<A>

Sets flex-grow weight to one. Read more
Source§

fn flex_grow_by(self, value: f32) -> View<A>

Sets the dimensionless flex-grow weight. Read more
Source§

fn flex_shrink(self, value: f32) -> View<A>

Sets the dimensionless flex-shrink weight. Read more
Source§

fn flex_basis(self, value: impl Into<Length>) -> View<A>

Sets the preferred main-axis flex basis. Read more
Source§

fn align_self(self, value: AlignItems) -> View<A>

Overrides the parent cross-axis alignment for this view. Read more
Source§

fn fill_width(self) -> View<A>

Marks width as parent-fill in the view size hint. Read more
Source§

fn fill_height(self) -> View<A>

Marks height as parent-fill in the view size hint. Read more
Source§

fn fill(self) -> View<A>

Marks both axes as parent-fill in the view size hint. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

§

impl<T, A> IntoViewKeyExt<A> for T
where T: IntoView<A>,

§

fn key(self, key: impl Into<String>) -> View<A>

Converts self, assigns the owned key, and returns the view. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<T> ErasedDestructor for T
where T: 'static,