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, or read a topic guide to learn a subsystem end to end. For the complete lookup of every public name, see the API Reference; for the visual widget catalog, see Widgets.

Getting started#

Installation

Install bootstack and confirm your environment is ready.

Installation
Quick Start

Your first window, a navigation app, and reactive state — in a few minutes.

Quick Start
App Structures

Choose the right top-level container: App, AppShell, or Window.

App Structures

How-to guides#

Getting Input

Text, numbers, dates, choices, and sliders — and binding them to state.

Getting Input
Composing Fields

Add icons, labels, buttons, and toggles inside a field to specialize it.

Composing Custom Fields
Handling Actions

Buttons, events, debounced streams, shortcuts, and menus.

Handling Actions
Displaying Data

Labels, lists, tables, trees, and the data sources behind them.

Displaying Data
Building Forms

Lay out fields and validate them before submit.

Building Forms
Dialogs & Alerts

Alerts, confirmations, prompts, toasts, and custom dialogs.

Dialogs & Alerts
Navigation Patterns

Sidebar, master–detail, and workspace navigation shapes.

Navigation patterns
Layout & Spacing

Arrange widgets with stacks and grids; fill, expand, and anchor.

Layout & Spacing
Application Icons

Set the runtime and distribution icons from a single glyph.

Application Icons

Topics#

Theming

Color themes, runtime switching, and custom themes.

Theming
Typography

Fonts and the text-style tokens.

Typography
Images

Image handles and theme-aware icons.

Images and icons
Localization

Translatable text and locale-aware formatting.

Localization (i18n)
Signals

Reactive state that flows between widgets.

Signals
Events

The on_* model and the typed payloads handlers receive.

Events
Streams

Compose, filter, debounce, and throttle event pipelines.

Streams
Validation

Rules that check what a user enters.

Validation
Data Sources

Sources, the col() query language, filtering, and paging.

Data Sources
Storage

A file-backed preferences store.

Preferences Store
Shortcuts

Register application keyboard shortcuts.

Shortcuts
Scheduling

Run work after a delay or on a repeating interval.

Scheduling
Errors

The exception types bootstack raises.

Errors