ServiceBlocBuilder<Bloc extends ServiceBloc<ServiceRequestedEvent, ResponseData>, ServiceRequestedEvent extends ServiceRequested, ResponseData> class

ServiceBlocBuilder handles building a widget in response to relative state.

If parameter buildWhen is omitted, default buildWhen will only return true when certain parameter is set. For example onInitial onLoading onFailure. onSuccess is a required parameter so buildWhen will always return true if state is ServiceLoadSuccess

Inheritance

Constructors

ServiceBlocBuilder.new({Key? key, Bloc? bloc, BlocBuilderCondition? buildWhen, Widget onInitial(BuildContext context, ServiceInitial state)?, Widget onLoading(BuildContext context, ServiceLoadInProgress<ServiceRequestedEvent> state, ServiceRequestedEvent event)?, required Widget onSuccess(BuildContext context, ServiceLoadSuccess<ServiceRequestedEvent, ResponseData> state, ServiceRequestedEvent event, ResponseData data), Widget onFailure(BuildContext context, ServiceLoadFailure<ServiceRequestedEvent> state, ServiceRequestedEvent event, dynamic error)?, Widget fallback = const SizedBox()})
A constructor for creating a ServiceBlocBuilder with predefined state widget builder.

Properties

bloc → Bloc?
The bloc that the BlocBuilderBase will interact with. If omitted, BlocBuilderBase will automatically perform a lookup using BlocProvider and the current BuildContext.
finalinherited
builder → BlocWidgetBuilder<ServiceState>
The builder function which will be invoked on each widget build. The builder takes the BuildContext and current state and must return a widget. This is analogous to the builder function in StreamBuilder.
finalinherited
buildWhen → BlocBuilderCondition<ServiceState>?
An optional buildWhen can be implemented for more granular control over how often BlocBuilder rebuilds. buildWhen should only be used for performance optimizations as it provides no security about the state passed to the builder function. buildWhen will be invoked on each bloc state change. buildWhen takes the previous state and current state and must return a bool which determines whether or not the builder function will be invoked. The previous state will be initialized to the state of the bloc when the BlocBuilder is initialized. buildWhen is optional and if omitted, it will default to true.
finalinherited
fallback → Widget
A fallback widget for builder to use when build on first time or buildWhen got passed but widget builder function is omitted.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
onFailure → Widget Function(BuildContext context, ServiceLoadFailure<ServiceRequestedEvent> state, ServiceRequestedEvent event, dynamic error)?
A widget builder which is only called when buildWhen is omitted or custom buildWhen is passed onFailure is not omitted and current state is ServiceLoadFailure.
final
onInitial → Widget Function(BuildContext context, ServiceInitial state)?
A widget builder which is only called when build on first time or buildWhen is omitted or custom buildWhen is passed and onInitial is not omitted and current state is ServiceInitial.
final
onLoading → Widget Function(BuildContext context, ServiceLoadInProgress<ServiceRequestedEvent> state, ServiceRequestedEvent event)?
A widget builder which is only called when buildWhen is omitted or custom buildWhen is passed and onLoading is not omitted and current state is ServiceLoadInProgress.
final
onSuccess → Widget Function(BuildContext context, ServiceLoadSuccess<ServiceRequestedEvent, ResponseData> state, ServiceRequestedEvent event, ResponseData data)
A widget builder which is only called when buildWhen is omitted or custom buildWhen is passed and current state is ServiceLoadSuccess.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context, ServiceState state) → Widget
Returns a widget based on the BuildContext and current state.
inherited
createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<BlocBuilderBase<Bloc, ServiceState>>
Creates the mutable state for this widget at a given 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, 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