TCircularProgress class

A circular progress indicator that displays completion status.

TCircularProgress provides a customizable circular indicator with:

  • Support for current value (0.0 to 1.0)
  • Indeterminate state for unknown progress
  • Optional percentage text in the center
  • Customizable size and stroke width
  • Themed colors

Basic Usage

TCircularProgress(
  value: 0.7,
)

Indeterminate

TCircularProgress(
  indeterminate: true,
)
Inheritance
Available extensions

Constructors

TCircularProgress({Key? key, double value = 0.0, bool indeterminate = false, double size = 40.0, double strokeWidth = 4.0, Color? color, bool colorByPercentage = false, Color? colorBuilder(double value)?, Color? backgroundColor, bool showPercentage = false, String? valueText, Widget? center, String? label})
Creates a circular progress indicator.
const

Properties

backgroundColor → Color?
The color of the track (background circle).
final
center → Widget?
Optional custom widget to display inside the center of the circular indicator.
final
color → Color?
The color of the progress line.
final
colorBuilder → Color? Function(double value)?
Optional function to dynamically compute the color based on progress value (0.0 to 1.0).
final
colorByPercentage → bool
Whether to automatically color the progress indicator based on percentage:
final
hashCode → int
The hash code for this object.
no setterinherited
indeterminate → bool
Whether the progress is in an unknown state.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
label → String?
Optional label text displayed below the progress indicator.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showPercentage → bool
Whether to display the percentage text in the center.
final
size → double
The size (diameter) of the circular progress indicator.
final
strokeWidth → double
The width of the progress line.
final
value → double
The current progress value, from 0.0 to 1.0.
final
valueText → String?
Optional custom value text to display inside the circle (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.
build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
center({bool when = true}) → Widget

Available on Widget, provided by the WidgetX extension

Wraps this widget in a Center widget.
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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