ViewStateBuilder<T, C extends Cubit<ViewState>> class

ViewStateBuilder is responsible for building the UI based on the ViewState. It's a wrapper over the BlocBuilder widget so it accepts a bloc object and a set of handy callbacks, which corresponds to each possible state: onReady builder for the the initial state, onLoading builder for the data loading state, onRefreshing builder for the data refreshing state, onSuccess builder for the data success state, onEmpty builder for for no result state, onError builder function for an error state.

T - the type of elements, C - the type of cubit.

Inheritance

Constructors

ViewStateBuilder({Key key, C cubit, InitialBuilder onReady, LoadingBuilder onLoading, RefreshingBuilder<T> onRefreshing, SuccessBuilder<T> onSuccess, EmptyBuilder onEmpty, ErrorBuilder onError, ViewStateBuilderCondition buildWhen})

Properties

builder BlocWidgetBuilder<ViewState>
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.
final, inherited
buildWhen BlocBuilderCondition<ViewState>
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 cubit 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 cubit when the BlocBuilder is initialized. buildWhen is optional and if omitted, it will default to true. [...]
final, inherited
cubit → C
The cubit that the BlocBuilderBase will interact with. If omitted, BlocBuilderBase will automatically perform a lookup using BlocProvider and the current BuildContext.
final, inherited
hashCode int
The hash code for this object. [...]
@nonVirtual, read-only, inherited
key Key
Controls how one widget replaces another widget in the tree. [...]
final, inherited
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited

Methods

build(BuildContext context, ViewState 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<C, ViewState>>
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. [...]
@protected, inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node. [...]
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent 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. [...]
@nonVirtual, inherited