Widget reference

One page per widget, each with a live animation and runnable source. Use the table below to pick a widget by what it shows and whether it needs a known max_value – the widgets marked “No” work fine for indeterminate-length progress too.

Widget

Purpose

Needs known max_value

AbsoluteETA

Wall-clock time the run is expected to finish

Yes

AdaptiveETA

Time remaining estimated from the last few seconds, reacting to pace changes

Yes

AdaptiveTransferSpeed

Transfer speed averaged over a short recent window

No

AnimatedMarker

Spinner cycling through characters for indeterminate work

No

Bar

Classic left-to-right fill bar for a known total

Yes

BouncingBar

Marker bouncing back and forth for indeterminate work

No

Counter

Running count with no total to compare against

No

CurrentTime

Wall-clock date and time, updated live

No

DataSize

Single byte count scaled to a sensible unit, e.g. “12.5 MiB”

No

DynamicMessage

Legacy alias for Variable

No

ETA

Time remaining estimated from the whole-run average rate

Yes

FileTransferSpeed

Transfer rate averaged over the whole run

No

FormatCustomText

Arbitrary text rendered independent of the bar’s own progress

No

FormatLabel

Arbitrary %-style format string over the bar’s data snapshot

No

FormatLabelBar

Formatted label centered inside a fill bar

Yes

GranularBar

Fill bar with sub-character resolution via block glyphs

Yes

JobStatusBar

Marks each discrete job as succeeded or failed on the bar

No

MultiProgressBar

Several sub-jobs’ progress stacked into one bar’s fill levels

No

MultiRangeBar

Several named categories shown as proportional segments of one bar

No

Percentage

Current progress as a plain N% readout

Yes

PercentageLabelBar

Percentage centered inside a fill bar

Yes

Postfix

Live key=value mapping (or string) rendered after the bar

No

ReverseBar

Fill bar whose marker grows right to left

Yes

RotatingMarker

Legacy alias for AnimatedMarker

No

SimpleProgress

Raw count against its total, e.g. “5 of 47”

Yes

SmoothingETA

Time remaining via an exponential-moving-average rate, the library default

Yes

Timer

Elapsed time since the bar started, no max_value required

No

UnitProgress

Count against its total with a unit label, e.g. “12 of 24 files”

Yes

Variable

Live, named value with custom formatting, e.g. a training loss

No