RefreshProgressIndicator class

An indicator for the progress of refreshing the contents of a widget.

Typically used for swipe-to-refresh interactions. See RefreshIndicator for a complete implementation of swipe-to-refresh driven by a Scrollable widget.

The indicator arc is displayed with valueColor, an animated value. To specify a constant color use: AlwaysStoppedAnimation<Color>(color).

See also:

Inheritance

Constructors

RefreshProgressIndicator({Key? key, double? value, Color? backgroundColor, Color? color, Animation<Color?>? valueColor, double strokeWidth = defaultStrokeWidth, double strokeAlign = strokeAlignCenter, String? semanticsLabel, String? semanticsValue, StrokeCap? strokeCap, double elevation = 2.0, EdgeInsetsGeometry indicatorMargin = const EdgeInsets.all(4.0), EdgeInsetsGeometry indicatorPadding = const EdgeInsets.all(12.0)})
Creates a refresh progress indicator.
const

Properties

backgroundColor → Color?
Background color of that fills the circle under the refresh indicator.
no setteroverride
color → Color?
The progress indicator's color.
finalinherited
elevation → double
The z-coordinate at which to place this material relative to its parent.
final
hashCode → int
The hash code for this object.
no setterinherited
indicatorMargin → EdgeInsetsGeometry
The amount of space by which to inset the whole indicator. It accommodates the elevation of the indicator.
final
indicatorPadding → EdgeInsetsGeometry
The amount of space by which to inset the inner refresh indicator.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
semanticsLabel → String?
The SemanticsProperties.label for this progress indicator.
finalinherited
semanticsValue → String?
The SemanticsProperties.value for this progress indicator.
finalinherited
strokeAlign → double
The relative position of the stroke on a CircularProgressIndicator.
finalinherited
strokeCap → StrokeCap?
The progress indicator's line ending.
finalinherited
strokeWidth → double
The width of the line used to draw the circle.
finalinherited
value → double?
If non-null, the value of this progress indicator.
finalinherited
valueColor → Animation<Color?>?
The progress indicator's color as an animated value.
finalinherited

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<CircularProgressIndicator>
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

Constants

defaultStrokeWidth → const double
Default stroke width.