WithViewState class

Wraps child and shows a loader, an overlay loader or an error view according to viewState.

Works with ViewState from a Bloc state. It has no dependency on a router, localisation or networking package; customise the output with texts, errorBuilder and errorMessageResolver.

It fills the space it is given, so place it where the constraints are bounded (for example as a Scaffold body).

For remote-controlled screens (TV) set autofocusRetry so the main action of the default error view takes focus as soon as it appears.

Inheritance

Constructors

WithViewState({Key? key, required ViewState viewState, required Widget child, bool isRefreshable = false, VoidCallback retryAction = _noop, ErrorDisplayMode errorDisplayMode = ErrorDisplayMode.replace, ViewStateErrorBuilder? errorBuilder, ErrorMessageResolver? errorMessageResolver, ViewStateTexts texts = const ViewStateTexts(), bool autofocusRetry = false})
const

Properties

autofocusRetry → bool
Gives the main button of the default error view initial focus.
final
child → Widget
final
errorBuilder → ViewStateErrorBuilder?
Replaces the default error view for any state. Return null to fall back.
final
errorDisplayMode → ErrorDisplayMode
final
errorMessageResolver → ErrorMessageResolver?
Reads a message from errorModel. Without it, only a String model is shown.
final
hashCode → int
The hash code for this object.
no setterinherited
isRefreshable → bool
Adds pull-to-refresh around child that calls retryAction.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
retryAction → VoidCallback
Called by the Retry (or main action) button of the default error views.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
texts → ViewStateTexts
final
viewState → ViewState
final

Methods

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