bootstack.SelectButton#

class bootstack.SelectButton(options=None, *, value=None, signal=None, disabled=False, accent=None, variant='default', density=None, icon=None, localize=None, parent=None, **kwargs)#

Bases: IconProperty, PublicWidgetBase

A button that opens a dropdown value list — a button-styled alternative to Select.

Clicking the button opens a popup list of options. The selected value is displayed on the button face. Unlike Select, there is no text field — the button is the only interaction point.

Parameters:

  • options (list[Option] | None) – Choices shown in the popup. Each item is a plain string, a (text, value) tuple, or a {'text': ..., 'value': ...} dict — so an option’s displayed label can differ from its stored value, e.g. ["Light", "Dark"] or [("Light theme", "light")]. A dict option may also carry 'icon' (a glyph rendered beside the menu label) and 'disabled' (when True the item is dimmed and cannot be chosen); any other keys ride along as carried data on selection.

  • value (Any) – Initially selected value (value-space — matches an option’s value, not its label). Must match one of the options.

  • signal (Signal[str] | None) – Reactive Signal[str] controlling the selected value. When provided, value= is ignored — seed the Signal directly.

  • disabled (bool) – If True, the button is non-interactive and dimmed. Defaults to False.

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

  • variant (ButtonVariant) – Button style variant. Default 'solid'.

  • density (WidgetDensity | None) – Padding density.

  • icon (str | IconSpec | None) – Bootstrap Icons name shown on the button beside the value.

  • localize (bool | Literal['auto'] | None) – Whether option labels (and the selected label on the button face) are translated through the catalog — True, False, or 'auto' (translate when a translation is registered, otherwise show the literal). Defaults to the app’s localize_mode. Set False to keep proper nouns untranslated; override a single option with its localize key.

  • 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 disabled: bool#

Whether the button is non-interactive.

property icon: str | IconSpec | None#

The icon shown on the widget, or None if none is set.

A Bootstrap Icons name, or an IconSpec mapping ({'name', 'size', 'color'}) for control over size and color.

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 options: list[OptionDict]#

The available options as normalized {'text', 'value'} records.

Assigning a new list rebuilds the dropdown. Accepts the same Option forms as the constructor (strings, (text, value) tuples, or dicts).

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 selection: dict | None#

The selected option as a full record dict — the data bag — or None.

{'text': ..., 'value': ..., ...any extra keys}, indexed by key like any record. Read-only.

property signal: Signal[str] | None#

The reactive Signal linked to this button, or None.

property text: str#

The label currently shown on the button — the selected option’s text.

Read-only; the complement of value. Assign to value to change the selection.

property value: Any#

The currently selected value, or None if unselected.

This is the option’s value (value-space). For the displayed label, see text.

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.

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

on(event, handler=None)#

Bind handler to event, or return a composable Stream.

With a handler — binds immediately and returns a Subscription:

sub = widget.on("change", handler)
sub.cancel()

Without a handler — returns a Stream for operator chaining. The Tk binding is created lazily when .listen() is called:

sub = widget.on("change").debounce(300).listen(handler)
sub.cancel()
Parameters:

  • event (str) – Event name (e.g. "change", "click").

  • handler (Callable[[Any], Any] | None) – Optional callback. If omitted, a Stream is returned.

Returns:

Subscription when a handler is provided; Stream otherwise.

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_change() → Stream#
on_change(handler: Callable[[ChangeEvent], Any]) → Subscription

Register a callback fired whenever the selected value changes.

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

set_clipboard(text)#

Replace the system clipboard contents with text.

Parameters:

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