AsyncBuilder<T> class

A typed wrapper around FutureBuilder that swaps automatically between loading, success, and error states using kit defaults (shimmer skeletons + RetryableErrorWidget).

AsyncBuilder<List<Tx>>(
  future: api.fetchTransactions(),
  builder: (context, txs) => TxList(txs),
  onRetry: () => setState(() {}),
)
Inheritance
Available extensions

Constructors

AsyncBuilder({Key? key, required Future<T>? future, required Widget builder(BuildContext context, T data), WidgetBuilder? loadingBuilder, Widget errorBuilder(BuildContext context, Object error, StackTrace? stack)?, VoidCallback? onRetry, ShimmerType shimmerType = ShimmerType.basicListItem, int shimmerItemCount = 5, String errorMessage = 'Something went wrong. Please try again.'})
Creates an async builder.
const

Properties

builder Widget Function(BuildContext context, T data)
Builder invoked on success.
final
defaultHorizontalSpace SizedBox

Available on Widget, provided by the WidgetExtension extension

no setter
defaultVerticalSpace SizedBox

Available on Widget, provided by the WidgetExtension extension

no setter
errorBuilder Widget Function(BuildContext context, Object error, StackTrace? stack)?
Optional override for the error state. Defaults to a RetryableErrorWidget.
final
errorMessage String
User-facing message for the default error state.
final
future Future<T>?
The future whose lifecycle drives the UI.
final
hashCode int
The hash code for this object.
no setterinherited
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
loadingBuilder WidgetBuilder?
Optional override for the loading state. Defaults to a DefaultListShimmerWidget using shimmerType.
final
onRetry VoidCallback?
Called when the default error widget's "Retry" button is tapped. Ignored when errorBuilder is provided.
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
shimmerItemCount int
Number of shimmer rows in the default loading state.
final
shimmerType ShimmerType
Shimmer preset used by the default loading state.
final

Methods

build(BuildContext context) Widget
Describes the part of the user interface represented by this widget.
override
center() Center

Available on Widget, provided by the WidgetExtension extension

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
lightGreyBackground({required BuildContext context}) Container

Available on Widget, provided by the WidgetExtension extension

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
onTap(GestureTapCallback callback, {VoidCallback? onLongPress}) InkWell

Available on Widget, provided by the WidgetExtension extension

padAll({double? value}) Padding

Available on Widget, provided by the WidgetExtension extension

padBottom({double? bottom}) Padding

Available on Widget, provided by the WidgetExtension extension

padHorizontal({double? horizontal}) Padding

Available on Widget, provided by the WidgetExtension extension

padLeft({double? left}) Padding

Available on Widget, provided by the WidgetExtension extension

padRight({double? right}) Padding

Available on Widget, provided by the WidgetExtension extension

padTop({double? top}) Padding

Available on Widget, provided by the WidgetExtension extension

padVertical({double? vertical}) Padding

Available on Widget, provided by the WidgetExtension extension

padZero() Padding

Available on Widget, provided by the WidgetExtension 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
visible(bool visible, {Widget? defaultWidget}) Widget

Available on Widget, provided by the WidgetExtension extension

set visibility

Operators

operator ==(Object other) bool
The equality operator.
inherited