bootstack.Carousel#

class bootstack.Carousel(*, items=None, data_source=None, image_field='image', caption_field=None, index=0, fit='contain', transition='slide', show_arrows=True, indicator='dots', autoplay=False, interval=4000, loop=True, corner_radius=0, aspect_ratio=1.5, height=None, accent=None, surface=None, parent=None, **kwargs)#

Bases: PublicWidgetBase

Shows one image slide at a time, with prev/next navigation.

Carousel steps through a collection of image records one slide at a time — the focus-on-one counterpart to Gallery. It pairs naturally with Gallery.on_item_activate to open a full-size pop-up viewer: a Carousel over the same items, starting at the activated slide.

Each record names the image through image_field (an Image, a file path, or a PIL image) and, optionally, a caption through caption_field. Navigate with the on-screen chevrons, the arrow keys, the indicator dots, or the next/previous/go_to methods.

Parameters:

items (list[dict] | None) – Initial list of record dicts.
data_source (DataSourceProtocol | None) – A data source for database- or API-backed data.
image_field (str) – Record key holding each slide’s image. Default 'image'.
caption_field (str | None) – Record key for the caption overlaid on each slide. Default None (no captions).
index (int) – The slide shown first. Default 0.
fit (ImageFit) – How each image is scaled into the stage — 'contain' (default, shows the whole image), 'cover', 'fill', 'none', or 'scale-down'. See Picture.
transition (Transition) – Animation between slides — 'slide' (default), 'fade', or 'none'.
show_arrows (bool) – Show the overlaid prev/next chevrons. Default True.
indicator (Indicator) – The slide indicator — 'dots' (default; auto-switches to a counter when there are many slides), 'count', or 'none'.
autoplay (bool) – Auto-advance through the slides. Default False.
interval (int) – Autoplay dwell time per slide, in milliseconds. Default 4000.
loop (bool) – Wrap around past the first and last slides. Default True.
corner_radius (int) – Rounded-corner radius for the slide image, in pixels. Default 0.
aspect_ratio (float) – Width-to-height ratio used to derive the carousel’s minimum height when it sits in a container that doesn’t impose one (a scroll view, an auto-fit window) — a larger ratio gives a wider, shorter floor. Default 1.5. Ignored when height is set. fill/expand still grow the stage past this floor.
height (int | None) – Explicit minimum height for the slide stage, in pixels. Overrides aspect_ratio. Default None (derive from aspect_ratio).
accent (AccentToken | str | None) – Color intent token to brand the active indicator dot. By default the dots are neutral (white), which reads on any image; set this to color the active dot.
surface (SurfaceToken | str | None) – Background surface token shown behind a letterboxed slide.
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 count: int#: The number of slides.

property current: dict | None#: The currently shown record — the data bag — or None when empty.

property data_source: DataSourceProtocol#: The underlying data source instance.

property index: int#: The index of the currently shown slide. Assign to jump to a slide.

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 is_playing: bool#: Whether autoplay is currently running.

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

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

go_to(index)#

Jump to the slide at index, animating in the right direction.

Parameters:: index (int) – The slide index to show.

next()#

Advance to the next slide.

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[[dict[str, Any]], Any]) → Subscription

Fired when the active slide changes.

Parameters:: handler (Callable[[dict[str, Any]], Any] | None) – Called with the now-current record dict — read fields with e["field"]. 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

on_item_click() → Stream#

on_item_click(handler: Callable[[dict[str, Any]], Any]) → Subscription

Fired when the current slide is clicked.

The natural hook for closing a pop-up viewer or opening a detail view.

Parameters:: handler (Callable[[dict[str, Any]], Any] | None) – Called with the current record dict. Omit to get a composable Stream.
Returns:: A cancellable Subscription when a handler is given, otherwise a Stream.
Return type:: Stream | Subscription