DeclarativeRefreshIndicator class

A declarative RefreshIndicator alternative.

The API is inspired by Switch and Checkbox: The indicator itself does not maintain any state. Instead, when the state of the indicator changes, the widget calls the onRefresh callback. Most widgets that use an indicator will listen for the onRefresh callback and rebuild the indicator with a new refreshing value to show and hide it.

With the exception of refreshing and onRefresh, all properties are equivalent to RefreshIndicator properties or function arguments with the same name.

Inheritance

Constructors

DeclarativeRefreshIndicator({Key? key, required Widget child, required bool refreshing, required VoidCallback onRefresh, bool atTop = true, double displacement = 40, Color? color, Color? backgroundColor, ScrollNotificationPredicate notificationPredicate = defaultScrollNotificationPredicate, String? semanticsLabel, String? semanticsValue, double strokeWidth = 2, RefreshIndicatorTriggerMode triggerMode = RefreshIndicatorTriggerMode.onEdge})
const

Properties

atTop → bool
Equivalent to the atTop argument in RefreshIndicatorState.show.
final
backgroundColor → Color?
Equivalent to RefreshIndicator.backgroundColor.
final
child → Widget
Equivalent to RefreshIndicator.child.
final
color → Color?
Equivalent to RefreshIndicator.color.
final
displacement → double
Equivalent to RefreshIndicator.displacement.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
notificationPredicate → ScrollNotificationPredicate
Equivalent to RefreshIndicator.notificationPredicate.
final
onRefresh → VoidCallback
Called when the user triggers a refresh.
final
refreshing → bool
Whether the indicator should be shown or hidden.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
semanticsLabel → String?
Equivalent to RefreshIndicator.semanticsLabel.
final
semanticsValue → String?
Equivalent to RefreshIndicator.semanticsValue.
final
strokeWidth → double
Equivalent to RefreshIndicator.strokeWidth.
final
triggerMode → RefreshIndicatorTriggerMode
Equivalent to RefreshIndicator.triggerMode.
final

Methods

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