OudsLinearProgressIndicator class
Reference design version : 1.0.0
A linear progress indicator that shows the progress of a task as a horizontal bar. Supports both determinate and indeterminate modes and is best placed inside layouts where vertical space is available.
The component can optionally display:
- a stop indicator at the end of the active bar,
- helper text below the indicator,
- a percentage value,
- and custom horizontal alignment for the helper text.
Parameters
- progressType: Determinate or indeterminate display mode.
- status: Visual color status. Non-semantic (Neutral, Accent) for standard progress; semantic (Positive, Warning, Negative, Info) when the operation carries a meaning.
- animated: Enables smooth value-change animation (determinate only). Automatically disabled when the OS reduced-motion setting is on.
- value: Value between
0.0and1.0. Passnullfor indeterminate. - gapSize: Gap between the active bar and its track — OudsProgressIndicatorGapSize.
- track: Whether the background track bar is visible.
- semanticLabel: Accessibility label for assistive technologies.
- stopIndicator: Displays a square (or circle when rounded) block at the end of the active bar.
- helperText: Optional text displayed below the indicator.
- helperTextAlignment: Horizontal alignment of the helper text — OudsProgressIndicatorHelperTextAlignment.
- percentage: When
true, the helper text is generated from value and formatted as a percentage; whenfalse, helperText is used. - spaceBeforePercentage: Inserts a non-breaking space before the
%symbol when percentage istrue(e.g.75 %instead of75%).
Example
OudsLinearProgressIndicator(
progressType: OudsProgressIndicatorType.determinate,
status: Positive(),
progress: 0.8,
track: true,
animated: true,
stopIndicator: false,
helperText: 'Uploading file',
helperTextAlignment: OudsProgressIndicatorHelperTextAlignment.center,
percentage: false,
spaceBeforePercentage: false,
)
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- OudsProgressIndicator
- OudsLinearProgressIndicator
Constructors
- OudsLinearProgressIndicator({Key? key, OudsProgressIndicatorType? progressType = OudsProgressIndicatorType.determinate, OudsIconStatus status = const Neutral(), bool animated = true, double? value, OudsProgressIndicatorGapSize gapSize = OudsProgressIndicatorGapSize.defaultSize, bool track = true, String? semanticLabel, bool stopIndicator = false, String? helperText, OudsProgressIndicatorHelperTextAlignment helperTextAlignment = OudsProgressIndicatorHelperTextAlignment.center, bool percentage = false, bool spaceBeforePercentage = false})
-
const
Properties
- animated → bool
-
finalinherited
- gapSize → OudsProgressIndicatorGapSize
-
finalinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- helperText → String?
-
Optional text displayed below the indicator.
final
- helperTextAlignment → OudsProgressIndicatorHelperTextAlignment
-
Horizontal alignment of the helper text below the indicator.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- percentage → bool
-
When
true, the helper text is replaced by the formatted progress percentage (e.g.75%). helperText is ignored.final - progressType → OudsProgressIndicatorType?
-
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- semanticLabel → String?
-
finalinherited
- spaceBeforePercentage → bool
-
Inserts a space between the numeric value and the
%symbol when percentage istrue(e.g.75 %instead of75%).final - status → OudsIconStatus
-
finalinherited
- stopIndicator → bool
-
Whether to display a stop block at the right end of the active bar.
final
- track → bool
-
finalinherited
- value → double?
-
finalinherited
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< OudsLinearProgressIndicator> -
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
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
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
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited