User Guide#
Everything you need to build real applications with bootstack — start with setup and the basics, reach for a how-to when you have a specific task in mind, read a feature guide to learn a subsystem end to end, or pick up the developer tools that run, debug, and package your app. For the complete lookup of every public name, see the API Reference; for the visual widget catalog, see Widgets.
Getting started#
Install bootstack and confirm your environment is ready.
Your first window, a navigation app, and reactive state — in a few minutes.
Choose the right top-level container: App, AppShell, or Window.
How-to guides#
Arrange widgets with stacks and grids; fill, expand, and anchor.
Text, numbers, dates, choices, and sliders — and binding them to state.
Buttons, events, debounced streams, shortcuts, and menus.
Read and write the system clipboard.
Labels, lists, tables, trees, and the data sources behind them.
Embed themed matplotlib/seaborn charts that update from a signal or source.
Add icons, labels, buttons, and toggles inside a field to specialize it.
Reusable components from plain functions that build widgets.
Lay out fields and validate them before submit.
Alerts, confirmations, prompts, toasts, and custom dialogs.
Sidebar, master–detail, and workspace navigation shapes.
Set the runtime and distribution icons from a single glyph.
Intro screens that cover startup — timed branding, welcome, real progress.
Save a window or a single widget as a PNG, JPEG, or PDF the user can share.
Feature guides#
Configure the app at construction and read or change it live at runtime.
Color themes, runtime switching, and custom themes.
Fonts and the text-style tokens.
Image handles and theme-aware icons.
Translatable text and locale-aware formatting.
Reactive state that flows between widgets.
The on_* model and the typed payloads handlers receive.
Compose, filter, debounce, and throttle event pipelines.
Rules that check what a user enters.
Sources, the col() query language, filtering, and paging.
A file-backed preferences store.
Register application keyboard shortcuts.
Run work after a delay or on a repeating interval.
The exception types bootstack raises.
Developer tools#
The bootstack command — scaffold, run, add components, and explore the
framework.
Edit and save to update the running app in place with bootstack dev.
The doctor health check, full tracebacks, and the exceptions to expect.
Package a project into a standalone executable with PyInstaller.