Struct PasswordField 

pub struct PasswordField { /* private fields */ }

Secure single-line text entry. See the module docs.

Implementations

impl PasswordField

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

Construct a secure field bound to password.

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

Placeholder shown when empty. Never masked.

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

Accessible name, applied to the Role::PasswordInput field node. Strongly recommended for screen-reader users.

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

Set the enabled state, statically or reactively. Forwarded to the arena at build time — a bound Signal<bool> updates live as it changes.

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

Read-only: selection works, edits don’t.

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

Hard cap on length in chars.

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

Per-character input filter (applied to keystrokes, IME commits, and paste).

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

Commit-time validator (Enter / blur). Drives the inline validation strip and aria-invalid.

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

Fired on Enter (focus stays put).

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

Fired once per focus-loss.

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

Minimum frame width (logical px). Default 65.

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

Frame variant (Outlined / Filled / Underline / Bare).

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

Per-instance style override.

pub fn echo_char(self, c: char) -> Self

Override the masking glyph (default '•').

pub fn echo_mode(self, mode: EchoMode) -> Self

Set the EchoMode (default EchoMode::Masked).

pub fn reveal_mode(self, mode: RevealMode) -> Self

Set the RevealMode (default RevealMode::Toggle).

pub fn revealed(self, revealed: Signal<bool>) -> Self

Bind an external reveal signal (shared with other UI, observed for analytics, or driven programmatically). Defaults to an internal signal exposed via revealed_signal.

pub fn allow_copy(self, allow: bool) -> Self

Permit copy / cut even while masked (default false). Copy is always allowed while revealed regardless of this flag.

pub fn caps_lock_warning(self, on: bool) -> Self

Show a Caps Lock warning when focused with Caps Lock on (default true). The warning is announced to screen readers via a polite live region.

pub fn at_reveal_policy(self, policy: AtRevealPolicy) -> Self

How a revealed field reports to assistive tech (default AtRevealPolicy::SwapRole).

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

Plain single-line tooltip shown on hover.

Mutually exclusive with rich_tooltip_key, rich_tooltip, rich_tooltip_content, and composite_tooltip — calling any of them clears the others.

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

Registry-keyed rich tooltip.

Mutually exclusive with the other tooltip setters.

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

Inline rich tooltip (canonical name: accepts a TooltipContent directly without a registry key).

Mutually exclusive with the other tooltip setters.

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

Inline rich tooltip.

Mutually exclusive with the other tooltip setters. Prefer rich_tooltip_content for the canonical API.

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

Composite (arbitrary-widget) tooltip.

Mutually exclusive with the other tooltip setters.

pub fn revealed_signal(&self) -> Signal<bool>

The reveal-state signal (true = plaintext shown). Useful to observe or drive reveal programmatically.

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

The bound password signal.

Trait Implementations

impl Debug for PasswordField

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

Formats the value using the given formatter.

impl Widget for PasswordField

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

Declare this widget’s accessibility identity.

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