bootstack.PasswordField#

class bootstack.PasswordField(value='', *, placeholder=None, textsignal=None, label=None, message=None, required=False, mask='•', show_visibility_toggle=True, read_only=False, disabled=False, width=None, accent=None, density=None, parent=None, **kwargs)#

Bases: FieldAddonMixin, PublicWidgetBase

A masked text field for password input with an optional visibility toggle.

The initial value is the first positional argument. All options are keyword-only.

Parameters:

  • value (str) – Initial password value (displayed masked).

  • placeholder (str | None) – Ghost text shown when the field is empty and unfocused.

  • textsignal (Signal[str] | None) – Reactive Signal[str] bound to the field text. The field value and signal stay in sync automatically.

  • label (str | None) – Label displayed above the field.

  • message (str | None) – Hint or helper text displayed below the field.

  • required (bool) – If True, marks the field as required and prevents empty submission.

  • mask (str) – Character used to mask each typed character. Defaults to '•'.

  • show_visibility_toggle (bool) – If True (default), shows the eye-icon button that reveals the password while held.

  • read_only (bool) – If True, text is visible and selectable but not editable.

  • disabled (bool) – If True, field is fully non-interactive and dimmed.

  • width (int | None) – Width in character units.

  • accent (AccentToken | str | None) – Accent token applied to the focus ring.

  • density (WidgetDensity | None) – Padding density.

  • parent (Any) – Explicit parent widget. If omitted, the current context-stack container is used.

  • **kwargs (Any) – Layout placement options applied by the parent container — fill, expand, anchor, margin, row, column, sticky. See Layout & Spacing.

property addons: dict[str, Any]#

Named addon widgets inserted via insert_addon().

property disabled: bool#

Whether the field is fully non-interactive.

property is_attached: bool#

Whether the widget is currently placed in its layout.

True while the widget occupies space in its parent; False after detach (or before it has ever been placed). A detached widget keeps its state and can be returned to the layout with attach.

property read_only: bool#

Whether the field is visible but not editable.

property schedule: Schedule#

Scheduler tied to this widget’s lifetime.

All jobs are automatically cancelled when the widget is destroyed. First access creates the Schedule instance; subsequent accesses return the same instance.

Usage:

self.schedule.delay(500, callback)
self.schedule.every(1000, tick)
job = self.schedule.idle(refresh)
job.cancel()
property signal: Signal[str] | None#

The reactive Signal bound to this field, or None.

property text: str#

The current display text shown in the field.

This is the formatted string the user sees, as opposed to value, which is the raw parsed datum (e.g. for a DateField, text is 'Jan 2, 2024' while value is a date). Read-only — assign to value to change it.

property value: str#

The current text value of the field (unmasked).

add_validation_rule(rule_type, **kwargs)#

Add a validation rule to the field.

Rules run automatically on blur or key events depending on the rule type, or manually via validate(). Multiple rules can be added; they are evaluated in order and stop at the first failure.

Parameters:

  • rule_type (RuleType) – The kind of validation rule to apply.

  • **kwargs (Any) –

    Rule-specific options:

    • message (all rules) — override the default error message.

    • trigger (all rules) — when to run: 'always' (key and blur), 'key', 'blur', or 'manual'. Each rule type has its own sensible default (see the Validation reference).

    • min, max (stringLength) — minimum/maximum character count.

    • pattern (pattern) — regex string the value must match.

    • other_field (compare) — field whose value must match.

    • func (custom) — callable (value: str) -> bool.

Example:

field.add_validation_rule("required")
field.add_validation_rule("stringLength", min=3, max=50)
field.add_validation_rule("email", message="Enter a valid email.")
field.add_validation_rule("custom", func=lambda v: v.isdigit())
attach(**kwargs)#

Return a detached widget to its layout, optionally moving it.

With no arguments, restores the widget to exactly where detach took it from. Any layout kwargs accepted by the original placement (e.g. fill, expand, anchor, sticky, margin) override the stored options. For stacked widgets, index= sets the position among the currently attached siblings (or pass an explicit before=/after= sibling); without one, the snapshotted position is used.

Calling attach on a widget that is already attached moves it (the kwargs are re-applied). Fires on_attach.

Parameters:

**kwargs (Any) – Layout placement options to override for this placement.

Raises:

ParentResolutionError – If the widget was never placed in a layout.

clear()#

Clear the field text.

delete(start, end=None)#

Delete characters from start to end.

Parameters:

  • start (int) – Start index (inclusive).

  • end (int | None) – End index (exclusive). If None, deletes to end of field.

destroy()#

Destroy the widget and release the resources it holds.

Removes the widget from its parent, destroys its children, and cancels any pending or repeating jobs on its schedule. After this the widget must not be used again. Destroying a container destroys everything inside it.

detach()#

Remove the widget from its layout without destroying it.

The widget stops occupying space but keeps its state, children, and event bindings, ready to be returned with attach. The current position is snapshotted so a plain attach() restores it exactly — for stacked siblings this is the index among the currently attached siblings, so detaching other siblings first shifts that index.

Calling detach on a widget that is already detached, or one that was never placed in a layout, does nothing. Fires on_detach.

emit(event, *, data=None)#

Fire a named event on this widget, as if it produced the event itself.

This is how a composite widget surfaces high-level activity to its listeners, and the generic counterpart to the on_*() shorthands for firing events that have no dedicated method.

Parameters:

  • event (str) – The event name, unprefixed — the same name you pass to on() or an on_<event>() shorthand (e.g. 'change', 'select').

  • data (Any) – The payload delivered to handlers. For a data-carrying event, pass the matching payload dataclass from bootstack.events — the same object an on_<event>() handler receives. Leave as None for native events (click, hover, focus, …), which carry no payload.

Example

widget.emit("change", data=bs.events.ChangeEvent(value=new_value))
focus()#

Give keyboard focus to this field.

get_clipboard()#

Return the current text contents of the system clipboard.

Returns:

The clipboard text, or an empty string when the clipboard is empty or holds non-text data.

Return type:

str

hide()#

Restore character masking.

insert(index, text)#

Insert text at index.

Parameters:

  • index (int) – Character position to insert at.

  • text (str) – Text to insert.

insert_addon(widget, position, *, name=None, text=None, icon=None, accent=None, on_click=None, signal=None, active_when_readonly=False)#

Insert a small widget inside the field border, before or after the input.

Use this for affordances such as a clear button, a search icon, a unit suffix label, or an on/off toggle.

Parameters:

  • widget (Literal['button', 'label', 'toggle']) – Addon type — 'button' (clickable), 'label' (static text or icon), or 'toggle' (on/off control).

  • position (Literal['before', 'after']) – 'before' (left of the input) or 'after' (right).

  • name (str | None) – Key to retrieve the addon later via addons. Auto-generated if omitted.

  • text (str | None) – Text shown on the addon. Applies to any addon type.

  • icon (str | None) – Bootstrap Icons name shown on the addon (e.g. 'search', 'x-lg'). An icon-only addon is rendered when icon is given without text.

  • accent (AccentToken | str | None) – Accent token for the addon. Prefer an accent for a text-only button.

  • on_click (Callable[[], Any] | None) – Called with no arguments when a 'button' or 'toggle' addon is activated.

  • signal (Signal | None) – Reactive Signal[bool] bound to a 'toggle' addon’s on/off state.

  • active_when_readonly (bool) – Keep the addon interactive while the field is read-only. Off by default, so addons follow the field’s read-only state — appropriate since most act on the value (a clear button, the spin buttons). Set True only for a read-only-safe action such as a copy or reveal button; it still dims when the field is fully disabled.

Returns:

The created addon widget instance.

Return type:

Any

on(event: str) → Stream#
on(event: str, handler: Callable[[Event], Any]) → Subscription

Register a callback for an event by name.

A generic, string-keyed escape hatch — prefer the typed on_* shorthands (e.g. on_change), which carry the precise payload type. Called with no handler, returns a composable Stream; with a handler, binds it and returns a Subscription.

Parameters:

  • event (str) – Event name (for example 'change' or 'focus').

  • handler (Callable[[Event], Any] | None) – Called with the event payload. Omit to get a composable Stream instead.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

on_attach(handler=None)#

Register a callback fired when the widget enters the layout.

Fires each time the widget becomes visible in its parent — on initial placement and on every attach. Pair it with on_detach to keep per-visibility resources (timers, observers) tied to the widget’s presence on screen. The handler receives a curated Event.

Parameters:

handler (Callable[[Event], Any] | None) – Called when the widget is attached. Omit to get a composable Stream.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

on_blur() → Stream#
on_blur(handler: Callable[[Event], Any]) → Subscription

Register a callback fired when the field loses focus.

Parameters:

handler (Callable[[Event], Any] | None) – Called with an Event. Omit to get a composable Stream instead.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

on_change() → Stream#
on_change(handler: Callable[[ChangeEvent], Any]) → Subscription

Register a callback fired when the field value is committed.

Parameters:

handler (Callable[[ChangeEvent], Any] | None) – Called with a ChangeEvent. Omit to get a composable Stream instead.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

on_destroy(handler=None)#

Register a callback fired when the widget is destroyed.

Fires once, as the widget is torn down — the place to release resources the widget owns that aren’t cleaned up automatically (file handles, observers, external subscriptions). The handler receives a curated Event.

Parameters:

handler (Callable[[Event], Any] | None) – Called as the widget is destroyed. Omit to get a composable Stream.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

on_detach(handler=None)#

Register a callback fired when the widget leaves the layout.

Fires each time the widget stops occupying space in its parent — on detach and when an ancestor hides it. Pair it with on_attach to release per-visibility resources. The handler receives a curated Event.

Parameters:

handler (Callable[[Event], Any] | None) – Called when the widget is detached. Omit to get a composable Stream.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

on_focus() → Stream#
on_focus(handler: Callable[[Event], Any]) → Subscription

Register a callback fired when the field gains focus.

Parameters:

handler (Callable[[Event], Any] | None) – Called with an Event. Omit to get a composable Stream instead.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

on_input() → Stream#
on_input(handler: Callable[[InputEvent], Any]) → Subscription

Register a callback fired on every keystroke.

Parameters:

handler (Callable[[InputEvent], Any] | None) – Called with an InputEvent. Omit to get a composable Stream instead.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

on_invalid() → Stream#
on_invalid(handler: Callable[[ValidationEvent], Any]) → Subscription

Register a callback fired when validation fails.

Parameters:

handler (Callable[[ValidationEvent], Any] | None) – Called with a ValidationEvent. Omit to get a composable Stream instead.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

on_submit() → Stream#
on_submit(handler: Callable[[Event], Any]) → Subscription

Register a callback fired when the user presses Enter.

Parameters:

handler (Callable[[Event], Any] | None) – Called with an Event. Omit to get a composable Stream instead.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

on_valid() → Stream#
on_valid(handler: Callable[[ValidationEvent], Any]) → Subscription

Register a callback fired when validation passes.

Parameters:

handler (Callable[[ValidationEvent], Any] | None) – Called with a ValidationEvent. Omit to get a composable Stream instead.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

on_validate() → Stream#
on_validate(handler: Callable[[ValidationEvent], Any]) → Subscription

Register a callback fired after any validation run.

Parameters:

handler (Callable[[ValidationEvent], Any] | None) – Called with a ValidationEvent. Omit to get a composable Stream instead.

Returns:

A cancellable Subscription when a handler is given, otherwise a Stream.

Return type:

Stream | Subscription

remove_addon(name)#

Remove an addon inserted with insert_addon().

Parameters:

name (str) – The addon’s name (as passed to insert_addon).

Raises:

KeyError – If no addon with that name exists.

reveal()#

Remove character masking to show the password in plain text.

select_all()#

Select all text in the field.

select_range(start, end)#

Select text between start and end character positions.

Parameters:

  • start (int) – Start index (0-based, inclusive).

  • end (int) – End index (exclusive).

set_clipboard(text)#

Replace the system clipboard contents with text.

Parameters:

text (str) – The text to place on the clipboard.

update_addon(name, *, text=None, icon=None, accent=None, on_click=None)#

Reconfigure an existing addon in place.

Only the options you pass are changed. Use this, for example, to flip a toggle addon’s label between two units, or swap a button’s icon.

Parameters:

  • name (str) – The addon’s name (as passed to insert_addon).

  • text (str | None) – New text for the addon.

  • icon (str | None) – New Bootstrap Icons name for the addon.

  • accent (AccentToken | str | None) – New accent token for the addon.

  • on_click (Callable[[], Any] | None) – New click handler for a 'button' or 'toggle' addon.

Raises:

KeyError – If no addon with that name exists.

validate()#

Run validation rules against the current value.

Returns:

True if all rules pass, False otherwise.

Return type:

bool