Struct SearchField 

pub struct SearchField { /* private fields */ }

A search input with optional inline suggestions popup.

Implementations

impl SearchField

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

Create a search field bound to text, the reactive query string.

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

Per-call SearchFieldStyle override.

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

Set the placeholder text shown when the query is empty.

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

Set an accessible label for the field (announced by screen readers, not visually shown).

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

Wire this field to a listbox the caller owns, so arrow keys that move a highlight through that list are announced while focus stays here (the ARIA combobox pattern). listbox is the list’s node, active the currently-highlighted row’s node; both are forwarded to the inner TextInputField, which is the node that actually holds focus and therefore the only one whose active_descendant assistive technology follows.

This is for a search field driving a list built by its host — a command palette, a filter box above a results view. The built-in suggestion popup (suggestions) wires itself and needs none of this.

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

Set the initial enabled state. Forwarded to the arena at build time.

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

Install a callback invoked when the user presses Enter (or activates the search action).

pub fn with_suggestions(self, f: impl Fn(&str) -> Vec<String> + 'static) -> Self

Provider that returns suggestions for the current query string. When set, the popup appears below the field as soon as the user types at least Self::min_chars characters and the provider returns a non-empty list.

pub fn max_suggestions(self, n: usize) -> Self

Cap the number of suggestions shown in the popup (default 8, minimum 1).

pub fn min_chars(self, n: usize) -> Self

Minimum number of characters the user must type before suggestions appear (default 1).

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

Install a callback invoked when the user picks a suggestion (tap, Enter, or Space).

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

Show a plain one-line tooltip after a hover delay.

Mutually exclusive with rich_tooltip, rich_tooltip_content, and composite_tooltip — calling this clears the other slots (last call wins).

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

Show a registry-driven rich tooltip keyed by key.

Mutually exclusive with the other tooltip setters — last call wins.

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

Show an inline rich tooltip with the given TooltipContent.

Mutually exclusive with the other tooltip setters — last call wins.

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

Show a composite tooltip whose body is an arbitrary widget tree.

Mutually exclusive with the other tooltip setters — last call wins.

Trait Implementations

impl Debug for SearchField

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

Formats the value using the given formatter.

impl Widget for SearchField

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 accessibility(&self, builder: &mut AccessNodeBuilder)

Declare this widget’s accessibility identity.

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

Return the child widget IDs that this widget manages.

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).