OudsCircularProgressIndicatorHelperText class

Optional helper text displayed below an OudsCircularProgressIndicator.

The helper text can show the progress value formatted as a percentage (progress), a custom label, or both at once. By default, only the progress percentage is shown; add label to also display custom text. Unlike OudsLinearProgressIndicatorHelperText, there is no alignment option: the helper text is always centered below the indicator, combining the progress percentage and the label on a single line when both are shown.

The progress percentage is never shown when the indicator is indeterminate (progressType: OudsProgressIndicatorType.indeterminate), since there is no meaningful value to format — only label is displayed in that case.

Example

OudsCircularProgressIndicator(
  value: 0.75,
  helperText: OudsCircularProgressIndicatorHelperText(
    label: 'Uploading file',
  ),
)

Constructors

OudsCircularProgressIndicatorHelperText({bool progress = true, String? label}): const

Properties

hashCode → int: The hash code for this object.
no setterinherited
label → String?: Optional label displayed alongside (or instead of) the progress percentage.
final
progress → bool: Whether the progress value, formatted as a percentage, is displayed. Ignored (never shown) when the indicator is indeterminate.
final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toString() → String: A string representation of this object.
inherited

Operators

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