ProgressBar

A horizontal or vertical progress indicator. Use the determinate mode to show a fixed fill proportional to a known value, or the indeterminate mode for operations whose duration is unknown.

Usage

Determinate progress

Set value between 0 and max_value (default 100) to control the fill level. The bar fills proportionally.

bs.ProgressBar(value=0)    # empty
bs.ProgressBar(value=50)   # half full
bs.ProgressBar(value=100)  # complete

Read or update the value at any time via the value property:

bar = bs.ProgressBar(value=0)
bar.value = 42
print(bar.value)   # 42.0

Indeterminate mode

Use mode='indeterminate' for operations of unknown duration. Call start() to begin the animation and stop() to end it.

bar = bs.ProgressBar(mode="indeterminate")
bar.start()      # begins looping animation
# ... do work ...
bar.stop()

step(amount) advances the fill by amount (default 1.0) when you want manual control instead of an animation:

bar = bs.ProgressBar(value=0)
bar.step(10)   # value → 10
bar.step(10)   # value → 20

Signal binding

Pass a Signal to keep the bar in sync with a reactive value:

progress = bs.Signal(0.0)
bs.ProgressBar(signal=progress)
progress.value = 75   # bar updates automatically

Accent colors

bs.ProgressBar(value=65, accent="primary")
bs.ProgressBar(value=65, accent="success")
bs.ProgressBar(value=65, accent="warning")
bs.ProgressBar(value=65, accent="danger")

Thin variant

variant='thin' reduces the bar height for compact layouts or subtle progress indicators:

bs.ProgressBar(value=70, accent="primary", variant="thin")

Vertical orientation

bs.ProgressBar(value=60, orient="vertical")

Custom max value

Set max_value to match your data’s natural scale:

bs.ProgressBar(value=750, max_value=1000, accent="info")

Widget sizing

All widgets accept self-placement kwargs via **kwargs. The parent container determines which options apply — stack-based parents use stack kwargs, grid-based parents use grid kwargs. Unrecognised keys are silently ignored.

Stack

Used inside VStack, HStack, App, and other stack containers.

fill	Fill direction: 'x', 'y', 'both', or 'none'.
expand	Grow to consume extra space in the parent. True or False.
anchor	Alignment when the widget does not fill the available slot: 'n', 's', 'e', 'w', 'center', 'nw', etc.
margin	External spacing in pixels. Accepts an integer (equal on all sides), a 2-tuple (horizontal, vertical), or a 4-tuple (left, top, right, bottom).
margin_x	Horizontal external spacing (left and right). Accepts an integer or a 2-tuple (left, right) for asymmetric spacing. Overrides the horizontal component of margin=.
margin_y	Vertical external spacing (top and bottom). Accepts an integer or a 2-tuple (top, bottom) for asymmetric spacing. Overrides the vertical component of margin=.

Grid

Used inside a Grid container.

row / column	Zero-based row and column indices.
rowspan / columnspan	Number of rows or columns to span.
sticky	Alignment and fill within the grid cell. Any combination of 'n', 's', 'e', 'w' — e.g. 'ew' stretches horizontally, 'nsew' fills the entire cell.
margin	External spacing in pixels. Accepts an integer, a 2-tuple (horizontal, vertical), or a 4-tuple (left, top, right, bottom).
margin_x	Horizontal external spacing. Accepts an integer or (left, right).
margin_y	Vertical external spacing. Accepts an integer or (top, bottom).

API

The complete reference for ProgressBar lives on the Widgets API page. At a glance:

ProgressBar

A progress indicator bar.

Full Example

with bs.App(title="ProgressBar Demo", padding=20, gap=0) as app:
    with bs.Grid(columns=[1, 1], gap=(32, 20), sticky_items="new", fill="x", expand=True):

        # Quadrant 1 — Determinate progress
        with bs.VStack(gap=8):
            bs.Label("Determinate Progress", font="heading-sm")
            for pct in (0, 25, 50, 75, 100):
                bs.ProgressBar(value=pct, fill="x")

        # Quadrant 2 — Accent colors
        with bs.VStack(gap=8):
            bs.Label("Accent Colors", font="heading-sm")
            for accent in ("primary", "secondary", "info", "success", "warning", "danger"):
                bs.ProgressBar(value=65, accent=accent, fill="x")

        # Quadrant 3 — Thin variant
        with bs.VStack(gap=8):
            bs.Label("Thin Variant", font="heading-sm")
            bs.ProgressBar(value=40, variant="thin", fill="x")
            bs.ProgressBar(value=70, accent="primary", variant="thin", fill="x")
            bs.ProgressBar(value=90, accent="success", variant="thin", fill="x")

        # Quadrant 4 — Vertical orientation
        with bs.VStack(gap=8):
            bs.Label("Vertical Orientation", font="heading-sm")
            with bs.HStack(gap=12):
                for pct in (25, 50, 75, 100):
                    bs.ProgressBar(value=pct, orient="vertical")

app.run()