Struct TextInput 

pub struct TextInput { /* private fields */ }

Styled single-line text input composite.

See the module-level documentation for usage examples.

Implementations

impl TextInput

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

Construct a new text input bound to text.

pub fn variant(self, variant: TextInputVariant) -> Self

Pick a Tier-1 design-language variant (TextInputVariant::Outlined / Filled / Underline / Bare). The IntUI default (crate::styles::RecipeTextInputStyle) honours Outlined, Filled, and Bare; Underline falls back to Outlined until per-side stroke recipes land.

pub fn style(self, style: impl TextInputStyle) -> Self

Override the active [TextInputStyle] for this widget instance only. The widget keeps responsibility for caret blinking, IME composition, the placeholder layering, the leading / trailing slots and the validation strip — the style only paints the frame (border / fill / corner radius).

pub fn placeholder(self, text: impl Into<LocalizedString>) -> Self

Set the placeholder text shown when the field is empty.

pub fn label(self, label: impl Into<LocalizedString>) -> Self

Accessible name for the composite. Propagated to the outer container’s a11y node; the inner TextInputField still carries Role::TextInput with the document’s value.

pub fn enabled(self, enabled: impl Into<Prop<bool>>) -> Self

Set the enabled state, statically or reactively. Forwarded to the arena and the inner TextInputField at build time.

pub fn read_only(self, read_only: bool) -> Self

Set the field read-only: text is selectable and copyable but not editable.

pub fn max_length(self, max_length: usize) -> Self

Limit the number of Unicode scalar values the field will accept.

pub fn show_clear_button(self, show: bool) -> Self

Show or hide the trailing ✕ button that clears the field text. Default: hidden.

pub fn min_width(self, w: f32) -> Self

Override the frame’s intrinsic minimum width (default 65 dp). Use to express a design width for date / time / phone-number fields whose content is well-known and whose collapse to the generic 65 dp floor would look out of place.

pub fn leading_slot(self, widget: impl Widget + 'static) -> Self

Set an arbitrary widget in the leading slot (before the text area). Typically an IconButton or IconWidget.

pub fn trailing_slot(self, widget: impl Widget + 'static) -> Self

Set an arbitrary widget in the trailing slot (after the text area). Typically an IconButton or IconWidget.

pub fn on_submit_fn(self, f: impl Fn(&mut EventContext<'_>) + 'static) -> Self

Closure invoked on Enter. Forwarded to TextInputField.

pub fn on_blur_fn(self, f: impl Fn(&mut EventContext<'_>) + 'static) -> Self

Closure invoked on focus loss. Forwarded to TextInputField.

pub fn char_filter(self, f: impl Fn(char) -> bool + 'static) -> Self

Per-character input-filter predicate. Forwarded to TextInputField.

pub fn suffix(self, text: impl Into<String>) -> Self

Non-editable trailing string (Qt’s QSpinBox::suffix). Forwarded to TextInputField.

pub fn input_mask(self, mask: impl Into<String>) -> Self

Install an input mask (Qt grammar). Forwarded 1:1 to TextInputField::input_mask. Composing widgets like DateEdit use this to project the date format pattern onto the editing surface.

pub fn input_purpose(self, purpose: InputPurpose) -> Self

Declare the field’s semantic InputPurpose (WCAG 1.3.5), forwarded to the inner TextInputField to select a specialised AT role (e.g. Role::EmailInput).

pub fn active_descendant(self, active: Signal<Option<WidgetId>>) -> Self

Publish active_descendant on the inner field, pointing at the row a separate listbox is currently highlighting (the ARIA combobox pattern). Forwarded 1:1 to TextInputField::active_descendant, which is where it has to land: AT follows the focused node’s active descendant, and the inner field is the focusable one.

pub fn controls(self, listbox: Signal<Option<WidgetId>>) -> Self

Publish a controls relation to the listbox this input drives. Forwarded 1:1 to TextInputField::controls.

pub fn validator(self, f: impl Fn(&str) -> ValidationOutcome + 'static) -> Self

Install a commit-time validator. Forwarded 1:1 to TextInputField::validator. Pair with Self::validation_feedback_signal (or Self::validation_feedback) to surface the outcome in the inline strip.

pub fn caret_position(&self) -> Signal<usize>

Reactive caret position. Mirrors the inner field’s TextInputField::caret_position after build. Capture before ctx.add(text_input) — used by composing widgets (DateEdit segment-stepping) that need to know which segment Up/Down should step.

pub fn handle(&self) -> TextFieldHandle

A live handle on the inner field — its text-editing commands, for a host outside the widget.

Mirrors TextInputField::handle, and exists for the same reason: an application that routes Undo, Cut, Copy, Paste and Select All to “whichever text surface holds the caret” must be able to reach every such surface. A TextInput that could not be reached would silently lose its own Ctrl+Z to whatever the host routed the chord at instead.

Like caret_setter, safe to take before build: the handle reaches the field through a slot the widget fills in.

pub fn caret_setter(&self) -> Rc<dyn Fn(usize)>

Programmatic caret setter. Mirrors the inner field’s TextInputField::caret_setter. Returns a closure that is a no-op until build runs; afterwards it walks the inner field’s state and moves the document cursor. Capture before ctx.add(text_input).

pub fn validation_feedback_signal(&self) -> Signal<ValidationFeedback>

Reactive published validation feedback. Mirrors the inner field’s TextInputField::validation_feedback_signal after build. Composing widgets observe this to compose feedback across multiple fields (range editor’s worse-of-two ladder, etc.).

pub fn validation(self, validation: impl Into<Prop<ValidationState>>) -> Self

Bind an external ValidationState signal directly (e.g. when validation runs server-side), or set a fixed initial value. Use validation_feedback when wiring a local validator’s output.

A bound Signal becomes the shared write target used internally (by the validator-feedback bridge) and externally by the caller — preserving the two-way channel this method has always offered. A static value seeds a fresh, unshared signal.

pub fn validation_feedback(self, feedback: Signal<ValidationFeedback>) -> Self

Bridge a Signal<ValidationFeedback> (typically from a validator-equipped widget like DateEdit::validation_feedback_signal or a custom TextInputField) into this composite’s ValidationState. The feedback is mirrored on every change, translating outcomes into the composite’s display vocabulary:

• Pristine / Valid → ValidationState::None
• Corrected { message, .. } → ValidationState::Corrected(message)
• Invalid { message } → ValidationState::Error(message)

pub fn tooltip(self, text: impl Into<LocalizedString>) -> Self

Attach a plain tooltip. Accepts tr!(...) or lit!(...).

pub fn rich_tooltip_key(self, key: impl Into<String>) -> Self

Attach a registry-driven rich tooltip by key. Mutually exclusive with tooltip and composite_tooltip (last call wins).

pub fn rich_tooltip(self, content: TooltipContent) -> Self

Attach an inline rich tooltip from a pre-built tooltip::TooltipContent. Mutually exclusive with tooltip and composite_tooltip (last call wins).

pub fn rich_tooltip_content(self, content: TooltipContent) -> Self

Attach an inline rich tooltip from a pre-built tooltip::TooltipContent. Canonical alias for Self::rich_tooltip — matches the name used by Button, ComboBox, and other widgets. Mutually exclusive with tooltip and composite_tooltip (last call wins).

pub fn composite_tooltip(self, content: impl Widget + 'static) -> Self

Attach a composite tooltip — third tier, hosting an arbitrary widget tree. See Button::composite_tooltip.

pub fn text(&self) -> Signal<String>

The reactive text content signal.

Trait Implementations

impl Debug for TextInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Widget for TextInput

fn build(&mut self, ctx: &mut BuildContext<'_>) -> Vec<WidgetId>

Compose child widgets. Called once after the widget is placed in the arena, and again on environment change (theme switch, locale switch). Takes &mut self — store child IDs, signal handles, any state needed later. Returns the list of root child IDs (empty for leaf widgets).

fn layout_response( &self, proposal: SizeProposal, ctx: &LayoutContext<'_>, ) -> LayoutResponse

Respond to the parent’s size proposal with this widget’s wanted size, grow/shrink weights, and compression floor (see [LayoutResponse]).

fn place_children( &self, bounds: Rect, _proposal: SizeProposal, children: &mut [WidgetPlacement], _ctx: &LayoutContext<'_>, )

Position children within the allocated bounds.

fn children(&self) -> Vec<WidgetId>

Return the child widget IDs that this widget manages.

fn accessibility(&self, builder: &mut AccessNodeBuilder)

Declare this widget’s accessibility identity.

fn type_name(&self) -> &'static str

Concrete type name of this widget (e.g. "teksilo_widgets::button::Button"). The default implementation resolves at the impl site via std::any::type_name::<Self>(), so calls through &dyn Widget correctly dispatch to the monomorphized fn for the concrete type — getting the concrete name through the vtable without per-impl boilerplate.

fn cacheable_layout(&self) -> bool

Whether this widget’s layout_response may be memoized by the per-pass layout cache. Defaults to true.

fn paint(&self, _bounds: Rect, _canvas: &mut Canvas, _ctx: &PaintContext<'_>)

Draw the widget’s visual representation.

fn wants_after_paint(&self) -> bool

Whether this widget wants its after_paint hook to fire each frame. Returning false (the default) saves a virtual call per widget per frame for the vast majority of widgets that don’t aggregate descendant geometry.

fn after_paint(&self, _view: &WidgetTreeView<'_>, _ctx: &PaintContext<'_>)

Called once per frame after this widget’s subtree has finished painting. Receives a read-only view of the layout-resolved arena so a parent can read its descendants’ final bounds — e.g. TitleBar aggregates its drag region and control-button rects into a single HitRegions payload for the Windows backend’s WM_NCHITTEST.

fn wants_post_paint(&self) -> bool

Whether this widget wants its post_paint hook to fire each frame. Returning false (the default) saves a virtual call per widget per frame for the vast majority of widgets that don’t draw a foreground over their children.

fn post_paint( &self, _bounds: Rect, _canvas: &mut Canvas, _ctx: &PaintContext<'_>, )

Draw a foreground layer over this widget’s children.

fn wants_descendant_redirects(&self) -> bool

Whether this widget wants the AT walker to consult its a11y_redirect_descendant hook for every descendant during AT tree emission, not just its direct arena children.

fn a11y_redirect_descendant( &self, _self_id: WidgetId, _descendant: WidgetId, ) -> Option<NodeId>

Optional redirection hook for AT-tree placement of a child.

fn accessible_title_hint(&self) -> Option<String>

Suggest an accessible title to an enclosing container that wraps this widget as content — typically a modal / dialog shell that wants to propagate the inner content’s visible title as the shell’s own accessible name.

fn initial_focus_hint(&self) -> Option<WidgetId>

Optional hint that directs initial focus to a specific descendant when this widget is the root of a deferred-built modal surface.

fn accessibility_children(&self) -> Option<Vec<WidgetId>>

Optional override for the child ORDER presented to assistive technology, when it must differ from the paint / z-order child order returned by children.

fn as_any(&self) -> Option<&(dyn Any + 'static)>

Downcast hook. Default implementation returns None; concrete widgets override with Some(self) when they want to expose their concrete type to test-level introspection or reflection. The trait already bounds on std::any::Any so concrete types satisfy the 'static requirement.

fn as_any_mut(&mut self) -> Option<&mut (dyn Any + 'static)>

Mutable counterpart of as_any. Default returns None; widgets that want to expose mutable state to tests (e.g. so a test can mutate a Scene inside a SceneView post-layout) override with Some(self). Should follow the same opt-in pattern as as_any: only widgets that opt into & introspection should opt into &mut.

fn clips_children(&self) -> bool

Whether this widget clips its children to its bounds.

fn focus_reveal_rect(&self, _bounds: Rect) -> Option<Rect>

The rectangle (in absolute tree coordinates) that best represents this widget when the framework reveals it into an ancestor scroll area on focus gain. Returning None (the default) reveals the widget’s whole bounds — correct for most controls.

fn hit_shape(&self, _local_point: Point, _bounds: Rect) -> bool

Whether the point lies inside this widget’s actual shape, not just its rectangular bounds. Consulted by hit-testing right after the bounds check: returning false for a point that is inside the bounding box makes the widget transparent to the click there, so it falls through to whatever sibling is painted underneath (the same machinery as a fully pass-through node, but shape-aware).

fn preserves_children_on_rebuild(&self) -> bool

How rebuild_single_widget treats this widget’s existing children when re-running its build().

fn tooltip_has_content(&self) -> bool

Whether this widget, used as tooltip content, currently has anything worth showing.

fn declare_shortcuts(&self) -> Vec<Shortcut>

Declare the rebindable keyboard shortcuts this widget exposes, without installing handlers. The framework calls this at arena insertion time (before build()) and at certain lazy boundaries (e.g. Switcher walks declarations on its not-yet-mounted Pending slots), so settings UIs and the ShortcutRegistry see the keystrokes the moment the owning container mounts — even if build() hasn’t run.

fn take_handler_set(&mut self) -> Option<HandlerSet>

Extract attached handler set from a WidgetWithHandlers wrapper. Called during arena insertion to transfer handlers to the WidgetNode. Default: returns None (no attached handlers).