bootstack.ListView#

class bootstack.ListView(*, items=None, data_source=None, selection_mode='none', show_selection_controls=False, select_on_click=None, show_chevron=False, allow_remove=False, allow_reorder=False, striped=False, show_separators=True, show_scrollbar=True, scrollbar_variant='thin', height=None, density='default', accent=None, accent_selection=False, parent=None, **kwargs)#

Bases: PublicWidgetBase

A virtual-scrolling list for efficiently displaying large datasets.

Renders only visible rows, making it suitable for thousands of records. Populate via items= (a plain list of dicts) or data_source= (a data source for database-backed or API-backed data).

Each record dict should have an 'id' key; one is auto-generated if absent. Displayed fields are 'title', 'text', 'icon', and 'badge'. Other keys are stored and returned by selection and events but are not rendered.

Parameters:

  • items (list[dict] | None) – Initial list of record dicts.

  • data_source (DataSourceProtocol | None) – A data source for database-backed or API-backed data. Any object implementing the data-source protocol is accepted.

  • selection_mode (SelectionMode) – Item selection behavior — 'single' allows one item at a time, 'multi' allows several. Default 'none' (no selection).

  • show_selection_controls (bool) – If True, show checkboxes (multi) or radio buttons (single) alongside each item.

  • select_on_click (bool | None) – Whether clicking an item selects it. Defaults to True when selection_mode is not 'none'. Set False to decouple a click (e.g. activate or open) from selection.

  • show_chevron (bool) – If True, show a right-pointing chevron on each item.

  • allow_remove (bool) – If True, show a remove button on each item.

  • allow_reorder (bool) – If True, show a drag handle and allow reordering by dragging.

  • striped (bool) – If True, alternate the row background color.

  • show_separators (bool) – If True (default), draw a separator line between items.

  • show_scrollbar (bool) – If True (default), show the vertical scrollbar. Mousewheel scrolling works regardless.

  • scrollbar_variant (ScrollbarVariant) – Scrollbar style — 'thin' (default) for a slim bar suited to lists, or 'default' for the standard rounded bar.

  • height (int | None) – Fixed height in pixels. When set, the list maintains this height regardless of its children, making it self-contained for scrolling without requiring the parent layout to provide a vertical constraint. The widget can still grow beyond this height if placed with expand=True in a constrained parent.

  • density (WidgetDensity) – Row height. Default 'default'.

  • accent (AccentToken | str | None) – Color intent token for the selection highlight and drag indicator. Defaults to the theme’s default color.

  • 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 Layout & Spacing.

property data_source: DataSourceProtocol#

The underlying data source instance.

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

The selected record(s) — the data bag.

In 'single' mode, the selected record dict (or None when nothing is selected). In 'multi' mode, a list of record dicts (empty when nothing is selected). Each record carries its non-displayed fields too, indexed by key like any record. Read-only.

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

Deselect all items.

delete_item(record_id)#

Delete a record by ID.

Parameters:

record_id (Any) – ID of the record to delete.

deselect_items(record_ids)#

Remove the given items from the selection by record id.

Parameters:

record_ids (list) – Record ids to deselect.

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

insert_item(data)#

Insert a new record into the list.

Parameters:

data (dict) – Record dict. An 'id' is auto-generated if absent.

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_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 an item is clicked.

Parameters:

handler (Callable[[dict[str, Any]], Any] | None) – Called with the record dict — read fields with e["field"]. Omit to get a composable Stream instead.

Returns:

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

Return type:

Stream | Subscription

on_item_delete() → Stream#
on_item_delete(handler: Callable[[dict[str, Any]], Any]) → Subscription

Fired after an item is removed.

Parameters:

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

Returns:

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

Return type:

Stream | Subscription

on_item_drag_end() → Stream#
on_item_drag_end(handler: Callable[[dict[str, Any]], Any]) → Subscription

Fired when a drag ends.

Parameters:

handler (Callable[[dict[str, Any]], Any] | None) – Called with the record dict, including source_index and target_index. Omit to get a composable Stream instead.

Returns:

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

Return type:

Stream | Subscription

on_item_drag_start() → Stream#
on_item_drag_start(handler: Callable[[dict[str, Any]], Any]) → Subscription

Fired when a drag begins.

Parameters:

handler (Callable[[dict[str, Any]], Any] | None) – Called with the record dict, including source_index. Omit to get a composable Stream instead.

Returns:

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

Return type:

Stream | Subscription

on_item_insert() → Stream#
on_item_insert(handler: Callable[[dict[str, Any]], Any]) → Subscription

Fired after an item is inserted.

Parameters:

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

Returns:

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

Return type:

Stream | Subscription

on_item_update() → Stream#
on_item_update(handler: Callable[[dict[str, Any]], Any]) → Subscription

Fired after an item is updated.

Parameters:

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

Returns:

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

Return type:

Stream | Subscription

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

Fired when the selection changes.

Parameters:

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

Returns:

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

Return type:

Stream | Subscription

reload()#

Reload data from the datasource and refresh the display.

scroll_to_bottom()#

Scroll to the last item.

scroll_to_top()#

Scroll to the first item.

select_all()#

Select all items. Only effective when selection_mode='multi'.

select_items(record_ids)#

Select items by record id.

In 'single' mode this replaces the current selection; in 'multi' mode the items are added to it.

Parameters:

record_ids (list) – Record ids of the items to select.

set_clipboard(text)#

Replace the system clipboard contents with text.

Parameters:

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

update_item(record_id, data)#

Update an existing record.

Parameters:

  • record_id (Any) – ID of the record to update.

  • data (dict) – Fields to merge into the existing record.