API Reference#

The complete reference for the public API, grouped by concept. Every public class, function, and type has exactly one page here, titled by its full import path — so you can confirm an exact signature, read the full member list, or discover what lives alongside what.

Everything exposed at the top level — every widget, the application shells, reactive Signal state, and the dialog and theme verbs — is public and importable directly as bootstack.<name> (commonly import bootstack as bs). The following submodules are also public; import the names you need from each (e.g. from bootstack.data import col):

bootstack.data — Data sources and the col() query language behind tables, lists, and trees.
bootstack.events — Event objects and the typed payloads on_* handlers receive.
bootstack.streams — Composable event pipelines — debounce, filter, map.
bootstack.images — Image handles, themed icons, and application icons.
bootstack.style — Color themes, runtime theme switching, and fonts.
bootstack.validation — Rules that validate what a user enters.
bootstack.i18n — Translatable text and locale-aware formatting.
bootstack.scheduling — Running work after a delay or on a repeating interval.
bootstack.shortcuts — Registering application keyboard shortcuts.
bootstack.store — A small file-backed preferences store.
bootstack.clipboard — Read and write the system clipboard.
bootstack.errors — The exception types the framework raises.
bootstack.types — Token and keyword types for annotating your own code.
bootstack.dialogs — Reusable dialog classes, when a one-shot verb isn’t enough.

Everything else is internal. Modules and names beginning with an underscore — _core, _impl, _runtime, and the like — are implementation detail and may change at any time; the public API is exactly what this reference documents.

This is the lookup layer. For task-oriented introductions and worked examples, start from the Widgets catalog and the User Guide, which cross-link into the pages here.