Skip to content

FloodGauge

FloodGauge is a filled-level indicator that visualizes how full a value is within a range.

It's especially useful for capacity, utilization, or threshold-based indicators.

Quick start

import bootstack as bs

app = bs.App()

fg = bs.FloodGauge(app, value=75)
fg.pack(fill="x", padx=20, pady=20)

app.mainloop()

When to use

Use FloodGauge when:

  • capacity or fullness matters

  • thresholds are more important than exact numbers

  • visualizing resource utilization

Consider a different control when...

  • Tracking task progress over time — use Progressbar instead

  • You need a dashboard-style circular gauge — use Meter instead

  • You need a compact text-based indicator — use Badge instead

Appearance

Styling with accent

Flood gauges often change color as thresholds are crossed:

bs.FloodGauge(app, accent="warning")
bs.FloodGauge(app, accent="danger")
bs.FloodGauge(app, accent="success")

Design System

See Design System for color tokens and theming guidelines.

Examples & patterns

Value model

  • value represents fill level (commonly 0-100)

  • optional thresholds can alter styling

fg = bs.FloodGauge(app, value=80, maximum=100)
fg.pack()

Programmatic control

fg = bs.FloodGauge(app, value=50)
fg.pack()

# Get/set methods
current = fg.get()      # Returns 50
fg.set(75)              # Sets value to 75

# Property access
print(fg.value)         # Returns 75
fg.value = 90           # Sets value to 90

# Configure-style access
fg.configure(value=100)
print(fg.cget('value')) # Returns 100

Common options

  • value — current fill level

  • maximum — maximum value (default 100)

  • text — label displayed on the gauge

  • orient — orientation ("horizontal" or "vertical")

With text label

bs.FloodGauge(
    app,
    value=65,
    text="Storage"
).pack(fill="x", padx=20)

Vertical orientation

bs.FloodGauge(
    app,
    value=50,
    orient="vertical"
).pack(pady=20)

Behavior

  • The gauge fill level updates proportionally based on value / maximum

  • Visual updates occur when values are changed programmatically

  • Color/style can change based on threshold values

Reactivity

FloodGauge can be updated dynamically by binding to signals:

level = bs.Signal(25)
fg = bs.FloodGauge(app, value=level)

# Update value
level.set(90)  # FloodGauge updates automatically

Signals

See Signals for reactive programming patterns.

Additional resources

  • Progressbar — linear progress indicators

  • Meter — dashboard-style gauge indicators

  • Badge — compact status indicators

Framework concepts

API reference