ShadProgress class

A customizable linear progress indicator widget.

The ShadProgress widget displays a styled progress bar with configurable colors, height, and border radius. It integrates with ShadTheme for consistent styling and uses Container-based implementation instead of Material's LinearProgressIndicator.

Inheritance
Available extensions

Constructors

ShadProgress({Key? key, double? value, Color? backgroundColor, Color? color, Animation<Color?>? valueColor, double? minHeight, String? semanticsLabel, String? semanticsValue, BorderRadius? borderRadius, BorderRadius? innerBorderRadius})
Creates a progress bar widget with the specified properties.
const

Properties

backgroundColor → Color?
The background color of the progress bar. Defaults to the theme's secondary color if not specified.
final
borderRadius → BorderRadius?
The border radius of the progress bar's outer container. Defaults to a circular radius of 16 if not specified.
final
color → Color?
The color of the progress indicator itself. Defaults to the theme's primary color if not specified; overridden by valueColor if set.
final
hashCode → int
The hash code for this object.
no setterinherited
innerBorderRadius → BorderRadius?
The border radius of the progress indicator itself. Defaults to zero (sharp edges) if not specified.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
minHeight → double?
The minimum height of the progress bar. Defaults to 16 if not specified.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
semanticsLabel → String?
The accessibility label for the progress bar. Provides context to screen readers; defaults to null.
final
semanticsValue → String?
The accessibility value for the progress bar (e.g., percentage). Provides current progress to screen readers; defaults to null.
final
value → double?
The progress value between 0.0 and 1.0. If null, displays an indeterminate progress animation.
final
valueColor → Animation<Color?>?
An animated color value for the progress indicator. Overrides color if provided; defaults to null (uses color).
final

Methods

animate({Key? key, List<Effect>? effects, AnimateCallback? onInit, AnimateCallback? onPlay, AnimateCallback? onComplete, bool? autoPlay, Duration? delay, AnimationController? controller, Adapter? adapter, double? target, double? value}) → Animate

Available on Widget, provided by the AnimateWidgetExtensions extension

Wraps the target Widget in an Animate instance, and returns the instance for chaining calls. Ex. myWidget.animate() is equivalent to Animate(child: myWidget).
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<ShadProgress>
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
positionedWith(ShadPosition position) → Widget

Available on Widget, provided by the PositionedExt extension

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