AsyncBuilder<T> class
Builds loading, error and success UI from a Future.
AsyncBuilder<String>(
future: fetchProfile(),
onDone: (BuildContext context, String value) => Text(value),
onError: (BuildContext context, Object error) =>
ErrorState(onRetry: () => setState(() {})),
)
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- AsyncBuilder
- Available extensions
Constructors
-
AsyncBuilder({Key? key, Future<
T> ? future()?, T? initialValue, Widget? loading, Widget onLoading(BuildContext context)?, Widget onError(BuildContext context, Object error, StackTrace? stack)?, Widget onDone(BuildContext context, T value)?, bool retryOnError = true}) -
const
Properties
- centered → Widget
-
Available on Widget, provided by the WidgetX extension
Wraps the widget in a Center.no setter -
future
→ Future<
T> ? Function()? -
The future to await. Re-run by calling
retry.final - hashCode → int
-
The hash code for this object.
no setterinherited
- initialValue → T?
-
Value shown until the first future completes.
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- loading → Widget?
-
Placeholder widget shown while loading.
final
- onDone → Widget Function(BuildContext context, T value)?
-
Builds the success UI.
final
- onError → Widget Function(BuildContext context, Object error, StackTrace? stack)?
-
Builds the error UI.
final
- onLoading → Widget Function(BuildContext context)?
-
Builds the loading UI (used when loading is null).
final
- repaint → Widget
-
Available on Widget, provided by the WidgetX extension
Wraps in RepaintBoundary to isolate repaints.no setter - retryOnError → bool
-
Whether to expose a retry callback that re-runs future.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
animatedSwitcher(
{Duration duration = const Duration(milliseconds: 300), AnimatedSwitcherTransitionBuilder transitionBuilder = _defaultAnimatedSwitcherTransition, AnimatedSwitcherLayoutBuilder layoutBuilder = AnimatedSwitcher.defaultLayoutBuilder}) → Widget -
Available on Widget, provided by the WidgetX extension
Wraps in an AnimatedSwitcher withdurationand default fade. -
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → State< AsyncBuilder< T> > -
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
-
expanded(
{int flex = 1}) → Widget -
Available on Widget, provided by the WidgetX extension
Expands the widget inside a Flex parent. -
fadeIn(
{double opacity = 1, Duration duration = const Duration(milliseconds: 300), Curve curve = Curves.easeIn}) → Widget -
Available on Widget, provided by the WidgetAnimateX extension
Wraps in an AnimatedOpacity. -
flexible(
{int flex = 1, FlexFit fit = FlexFit.loose}) → Widget -
Available on Widget, provided by the WidgetX extension
Applies flexible sizing. -
keyed(
Object key) → Widget -
Available on Widget, provided by the WidgetX extension
Wraps the widget in a KeyedSubtree withkey. -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
onTap(
VoidCallback onTap, {HitTestBehavior behavior = HitTestBehavior.opaque}) → Widget -
Available on Widget, provided by the WidgetX extension
Wraps the widget in GestureDetector withonTap. -
pad(
{double horizontal = 0, double vertical = 0}) → Widget - Applies symmetric padding.
-
padded(
[double padding = AppSpacing.lg]) → Widget -
Available on Widget, provided by the WidgetX extension
Applies uniformpadding. -
scaleOnTap(
{double scale = 0.95, required VoidCallback onTap, Duration duration = const Duration(milliseconds: 150)}) → Widget -
Available on Widget, provided by the WidgetAnimateX extension
Wraps in an AnimatedScale. -
semantics(
{required String label, bool button = false}) → Widget -
Available on Widget, provided by the WidgetX extension
Wraps in a Semantics node withlabel. -
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
-
visible(
{bool condition = true}) → Widget -
Available on Widget, provided by the WidgetX extension
Hides the widget entirely whenconditionis false. -
withPadding(
EdgeInsetsGeometry padding) → Widget -
Available on Widget, provided by the WidgetX extension
Appliespaddingonly.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited