bootstack.ButtonGroup#

class bootstack.ButtonGroup(orient='horizontal', *, accent=None, variant='default', density='default', disabled=False, localize=None, parent=None, **kwargs)#

Bases: PublicWidgetBase

A row (or column) of visually-connected buttons sharing accent and variant.

Buttons are added via add() or add_all(). The group propagates accent, variant, and density to every member automatically. Listen for any button press with on_click(), which receives the key of the clicked button.

Parameters:

  • orient (Orient) – Layout orientation. Default 'horizontal'.

  • accent (AccentToken | str | None) – Accent token applied to all buttons.

  • variant (ButtonVariant) – Style variant. Default 'solid'.

  • density (WidgetDensity) – Widget density. Default 'default'.

  • disabled (bool) – If True, all buttons are non-interactive.

  • localize (bool | Literal['auto'] | None) – Whether button labels 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 button with add(..., localize=...).

  • parent (Any) – Override the context-stack parent.

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

property disabled: bool#

Whether all buttons are 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 items: tuple[Any, ...]#

All button items in insertion order.

property keys: tuple[str, ...]#

Keys of all buttons in insertion order.

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()
add(label='', *, key=None, icon=None, icon_position='left', disabled=False, localize=None, **kwargs)#

Add a button to the group.

Parameters:

  • label (str) – Button label text.

  • key (str | None) – Unique string key. Auto-generated if omitted.

  • icon (str | None) – Bootstrap Icons name (e.g. 'save', 'trash').

  • icon_position (IconPosition) – Position of the icon relative to the label. Ignored when icon_only is inferred or explicitly set. Default 'left'.

  • disabled (bool) – If True, this button starts disabled.

  • localize (bool | Literal['auto'] | None) – Translation mode for this button’s label, overriding the group’s localize=. Defaults to the group setting.

  • **kwargs (Any) – Further options for the rendered button, using its public parameter names. These override what add() derives — pass the caption as text if you prefer. command is owned by the group; use on_click(), which reports the button key.

Returns:

The key assigned to this button.

Return type:

str

add_all(items)#

Add multiple buttons at once.

Each item is either a label string or a dict of keyword arguments accepted by add().

Parameters:

items (list) – List of labels or dicts. A plain string is treated as the button label with no other options.

Returns:

List of keys assigned to each button, in insertion order.

Return type:

list[str]

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.

capture(path, *, inset=0, settle=0.1)#

Save a picture of this widget to an image file.

Captures the area this widget occupies on screen — one widget, a whole window, or the entire application, depending on what you call it on. The file extension selects the format, so .png, .jpg, and .pdf all work.

The widget has to be visible. A capture reads pixels from the display, so the window is brought to the front first and a hidden or detached widget cannot be captured at all. Any always-on-top setting the window already had is left as it was found.

Pair it with a save dialog to let the user choose where it goes:

import bootstack as bs

def on_export():
    chosen = bs.ask_save_file(initial_file="dashboard.png")
    if chosen:
        app.capture(chosen)
Parameters:

  • path (str | Path) – Where to write the image. Missing parent folders are created, and the extension chooses the format.

  • inset (int) – Pixels to trim from every edge, zero or more. Use 2 on a whole window to drop the native border artifact.

  • settle (float) – Seconds to let the desktop finish repainting before the pixels are read. The default covers the common case of a dialog closing just beforehand. The interface pauses for this long, so a second click on the control that started the capture waits its turn rather than starting an overlapping one.

Returns:

The path that was written.

Raises:

BootstackError – If the widget is not visible on screen or has been scrolled out of view, if inset is negative, if no capture backend is available, or if the file cannot be written.

Return type:

Path

Added in version 0.3.0.

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.

It is meant for the framework’s own events — 'change', 'select', 'input' and the rest of the data-carrying names. A handler registered through on() or an on_<event>() shorthand receives what is emitted.

Names that map onto a native event instead ('click', 'focus', 'blur', 'submit', …) are a different matter: emitting one asks the toolkit to deliver a real input event, which carries no payload and can reach handlers the widget installed for its own use. Emitting those is not a way to notify listeners, and a listener bound through on() may not see it. Drive the widget through its properties and methods instead.

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. Pass the matching payload dataclass from bootstack.events — the same object an on_<event>() handler receives.

Example

from bootstack.events import ChangeEvent

field.emit("change", data=ChangeEvent(value=new_value))
item(key)#

Return the button item object for key.

Parameters:

key (str) – Key returned by add().

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_click() → Stream#
on_click(handler: Callable[[ButtonGroupClickEvent], Any]) → Subscription

Register a callback fired when any button in the group is clicked.

Parameters:

handler (Callable[[ButtonGroupClickEvent], Any] | None) – Called with a ButtonGroupClickEvent (key, text, icon of the clicked button). Omit to get a composable Stream.

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

query_item(key, option)#

Return the current value of a configuration option for a button.

Parameters:

  • key (str) – Key returned by add().

  • option (str) – Option name to query (e.g. 'text', 'state').

remove(key)#

Remove the button identified by key.

Parameters:

key (str) – Key returned by add().

update_item(key, **kwargs)#

Reconfigure a button after creation.

Parameters:

  • key (str) – Key returned by add().

  • **kwargs (Any) – Options forwarded to the button’s configure().