TProgressBar class

A progress bar widget that displays completion status.

TProgressBar provides a customizable progress indicator with:

  • Support for current value (0.0 to 1.0)
  • Indeterminate state for unknown progress
  • Flowing animation for visual feedback
  • Flexible percentage/value position (TProgressValuePosition)
  • Custom labels and sizes
  • Animated value transitions

Basic Usage

TProgressBar(
  value: 0.7,
  label: 'Uploading...',
)

With Value Position

TProgressBar(
  value: 0.5,
  showPercentage: true,
  valuePosition: TProgressValuePosition.afterProgress,
)
Inheritance
Available extensions

Constructors

TProgressBar({Key? key, double value = 0.0, bool indeterminate = false, bool flowing = false, double height = 8.0, Color? color, Color? colorBuilder(double value, double percentage)?, Color? backgroundColor, String? label, bool showPercentage = false, String? valueText, TProgressValuePosition valuePosition = TProgressValuePosition.topRight, bool? inline, double borderRadius = 10.0, Duration animationDuration = const Duration(milliseconds: 300), TextStyle? valueStyle})
Creates a progress bar.
const

Properties

animationDuration → Duration
The duration of the progress value animation.
final
backgroundColor → Color?
The color of the track (background).
final
borderRadius → double
The border radius of the progress bar and track.
final
color → Color?
The color of the progress bar.
final
colorBuilder → Color? Function(double value, double percentage)?
Optional function to dynamically compute the color based on progress value (0.0 to 1.0) and percentage (0.0 to 100.0).
final
flowing → bool
Whether to show a continuous flowing/shimmer animation on the bar.
final
hashCode → int
The hash code for this object.
no setterinherited
height → double
The height of the progress bar.
final
indeterminate → bool
Whether the progress is in an unknown state.
final
inline → bool?
Whether to display the progress bar inline with its label and percentage.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label → String?
Optional label text displayed above or next to the progress bar.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showPercentage → bool
Whether to display the percentage text.
final
value → double
The current progress value, from 0.0 to 1.0.
final
valuePosition → TProgressValuePosition
The position of the percentage and value text relative to the progress bar.
final
valueStyle → TextStyle?
Optional custom text style for the percentage/value text.
final
valueText → String?
Optional custom value text to display (e.g. '50 / 1000').
final

Methods

box({double minW = 0.0, double minH = 0.0, double maxW = double.infinity, double maxH = double.infinity}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a ConstrainedBox to apply layout constraints.
center({bool when = true}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Center widget.
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<TProgressBar>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
expanded({int flex = 1}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in an Expanded widget.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
padding([double left = 0.0, double top = 0.0, double right = 0.0, double bottom = 0.0]) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with flexible edge control.
paddingSymmetric({double h = 0.0, double v = 0.0}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Padding with symmetric horizontal and vertical spacing.
size({double? w, double? h}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a SizedBox to apply fixed width and/or height.
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited
visible(bool visible, {bool maintainState = false}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Visibility widget.
when(bool condition) → Widget

Available on Widget, provided by the WidgetX extension

Returns this widget if condition is true, otherwise returns SizedBox.shrink(). Usage: Text('Hello').when(isVisible)

Operators

operator ==(Object other) → bool
The equality operator.
inherited