bootstack.ToggleButton#

class bootstack.ToggleButton(text='', *, signal=None, value=None, checked_value=True, unchecked_value=False, on_change=None, icon=None, on_icon=None, off_icon=None, icon_only=False, disabled=False, accent=None, variant='default', density=None, parent=None, **kwargs)#

Bases: _BooleanControlBase

A button that stays pressed when active — toolbar-style toggle.

Renders as a depressed button rather than a checkbox or switch. Commonly used in toolbars and button groups to represent a persistent on/off state.

Parameters:

  • text (str) – Button text.

  • signal (Signal | None) – Reactive Signal controlling the pressed state. When provided, value= is ignored — seed the Signal directly.

  • value (Any) – Initial value. Ignored when signal= is passed.

  • checked_value (Any) – Value representing the pressed/active state. Defaults to True.

  • unchecked_value (Any) – Value representing the unpressed/inactive state. Defaults to False.

  • on_change (Callable[[], Any] | None) – Shorthand callback fired on every toggle. Equivalent to btn.on_change(fn).

  • icon (str | None) – Bootstrap Icons name shown in both states — the fallback for on_icon/off_icon when those are not given. Pass on_icon/ off_icon to override the icon per state.

  • on_icon (str | None) – Bootstrap Icons name shown when the button is active/pressed. Use alone to swap icon on activation, or pair with off_icon= to show different icons per state, e.g. on_icon="star-fill", off_icon="star". Falls back to icon.

  • off_icon (str | None) – Bootstrap Icons name shown when the button is inactive. Can be used alone or paired with on_icon=. Falls back to icon.

  • icon_only (bool) – If True, shows only the icon with no label text. Requires icon=, on_icon=, or off_icon= to be set.

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

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

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

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

Whether the control is in the checked/on state.

property disabled: bool#

Whether the control is 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 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 | None#

The reactive Signal linked to this control, or None.

property value: Any#

The current value.

Returns checked_value when checked, unchecked_value when unchecked, or None when in the indeterminate state (only possible when tristate=True).

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(handler=None)#

Register a callback fired whenever the value changes.

Parameters:

handler (Callable[[ChangeEvent], Any] | None) – Called with a ChangeEvent carrying the new value and the prev_value (useful for tristate controls). Omit to get a composable Stream instead.

Returns:

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

Return type:

Stream | Subscription

on_check(handler=None)#

Register a callback fired when the control becomes checked/selected.

Parameters:

handler (Callable[[Event], Any] | None) – Called with the 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_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_uncheck(handler=None)#

Register a callback fired when the control becomes unchecked/deselected.

Parameters:

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

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.

toggle()#

Toggle the control’s state programmatically.