SoftBlocConsumer<B extends StateStreamable<DataState<T>>, T> class

Renders a bloc that emits DataStates, such as a BaseCubit, and handles its actions.

Rebuilds on screen states (loading, error, data, initial, and your own BuildState subclasses). Listens to ActionStates: shows a progress dialog while an action runs, a message when it fails, and calls onActionSuccess when it succeeds.

SoftBlocConsumer<UsersCubit, List<User>>(
  onRetry: () => context.read<UsersCubit>().loadUsers(),
  builder: (context, users) => UsersList(users),
)
Inheritance

Constructors

SoftBlocConsumer({Key? key, B? bloc, required DataWidgetBuilder<T> builder, Widget? stateBuilder(BuildContext context, DataState<T> state)?, WidgetBuilder? loadingBuilder, ErrorViewBuilder? errorBuilder, WidgetBuilder? initialBuilder, VoidCallback? onRetry, BlocWidgetListener<DataState<T>>? listener, ActionSuccessCallback? onActionSuccess, ActionErrorCallback? onActionError, bool showProgress = true})
Creates a consumer for bloc, or the nearest B from the context.
const

Properties

bloc → B?
The bloc; read from the context when null.
final
builder → DataWidgetBuilder<T>
Builds the data.
final
errorBuilder → ErrorViewBuilder?
Overrides the error view.
final
hashCode → int
The hash code for this object.
no setterinherited
initialBuilder → WidgetBuilder?
Overrides the initial view.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
listener → BlocWidgetListener<DataState<T>>?
Called for every action state, including your own ActionState subclasses, after the default handling, so adding a listener never turns off progress or error messages.
final
loadingBuilder → WidgetBuilder?
Overrides the loading view.
final
onActionError → ActionErrorCallback?
Called when an action fails, instead of the default error message.
final
onActionSuccess → ActionSuccessCallback?
Called when an action succeeds.
final
onRetry → VoidCallback?
Called by the error view's retry button.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
showProgress → bool
Whether to show a progress dialog while an action runs. Turn it off to show your own inline indicator instead.
final
stateBuilder → Widget? Function(BuildContext context, DataState<T> state)?
Builds your own BuildState subclasses. Return null for the initial view.
final

Methods

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