AsyncValueWidget<T> class

A Widget that responds to the state of an AsyncValue.

By default:

  • If value is an AsyncLoading, a circular progress indicator is displayed.
  • If value is an AsyncError, an error message is displayed.
  • If value is an AsyncData, the widget provided by builder is displayed.

All this behaviour can be customised by providing a loadingBuilder and/or errorBuilder.

Inheritance

Constructors

AsyncValueWidget({Key? key, required AsyncValue<T> value, required Widget builder(BuildContext, T), AnimatedSwitcherLayoutBuilder? layoutBuilder, Duration? transitionDuration, Curve? transitionSwitchInCurve, Curve? transitionSwitchOutCurve, Widget loadingBuilder(BuildContext context, Widget child)?, Widget errorBuilder(BuildContext context, Object error, Widget child)?, TextStyle? errorTextStyle, String? retryText, String parseError(Object error)?, VoidCallback? onRetry})
const

Properties

builder → Widget Function(BuildContext, T)
Builder that builds the widget when value is an AsyncData<T>
final
errorBuilder → (Widget Function(BuildContext context, Object error, Widget child)?)
Builds the error widget.
final
errorTextStyle → TextStyle?
Text style to use for the error message
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
layoutBuilder → AnimatedSwitcherLayoutBuilder?
See AnimatedSwitcher.layoutBuilder
final
loadingBuilder → (Widget Function(BuildContext context, Widget child)?)
Builds the loading widget.
final
onRetry → VoidCallback?
Called when the retry button is pressed.
final
parseError → (String Function(Object error)?)
Function that transforms an error Object into a String.
final
retryText → String?
Text to display on the retry button
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transitionDuration → Duration?
Duration of the transition between states
final
transitionSwitchInCurve → Curve?
Switch-in curve of the transition between states
final
transitionSwitchOutCurve → Curve?
Switch-out curve of the transition between states
final
value → AsyncValue<T>
The current value
final

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
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