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 |
|---|---|---|
Wall-clock time the run is expected to finish |
Yes |
|
Time remaining estimated from the last few seconds, reacting to pace changes |
Yes |
|
Transfer speed averaged over a short recent window |
No |
|
Spinner cycling through characters for indeterminate work |
No |
|
Classic left-to-right fill bar for a known total |
Yes |
|
Marker bouncing back and forth for indeterminate work |
No |
|
Running count with no total to compare against |
No |
|
Wall-clock date and time, updated live |
No |
|
Single byte count scaled to a sensible unit, e.g. “12.5 MiB” |
No |
|
Legacy alias for Variable |
No |
|
Time remaining estimated from the whole-run average rate |
Yes |
|
Transfer rate averaged over the whole run |
No |
|
Arbitrary text rendered independent of the bar’s own progress |
No |
|
Arbitrary %-style format string over the bar’s data snapshot |
No |
|
Formatted label centered inside a fill bar |
Yes |
|
Fill bar with sub-character resolution via block glyphs |
Yes |
|
Marks each discrete job as succeeded or failed on the bar |
No |
|
Several sub-jobs’ progress stacked into one bar’s fill levels |
No |
|
Several named categories shown as proportional segments of one bar |
No |
|
Current progress as a plain N% readout |
Yes |
|
Percentage centered inside a fill bar |
Yes |
|
Live key=value mapping (or string) rendered after the bar |
No |
|
Fill bar whose marker grows right to left |
Yes |
|
Legacy alias for AnimatedMarker |
No |
|
Raw count against its total, e.g. “5 of 47” |
Yes |
|
Time remaining via an exponential-moving-average rate, the library default |
Yes |
|
Elapsed time since the bar started, no max_value required |
No |
|
Count against its total with a unit label, e.g. “12 of 24 files” |
Yes |
|
Live, named value with custom formatting, e.g. a training loss |
No |
- AbsoluteETA
- AdaptiveETA
- AdaptiveTransferSpeed
- AnimatedMarker
- Bar
- BouncingBar
- Counter
- CurrentTime
- DataSize
- DynamicMessage
- ETA
- FileTransferSpeed
- FormatCustomText
- FormatLabel
- FormatLabelBar
- GranularBar
- JobStatusBar
- MultiProgressBar
- MultiRangeBar
- Percentage
- PercentageLabelBar
- Postfix
- ReverseBar
- RotatingMarker
- SimpleProgress
- SmoothingETA
- Timer
- UnitProgress
- Variable