RxLoader<R> class
Spinner/Busy indicator that reacts on the output of a Stream<CommandResult<dynamic, R>>
.
It's made especially to work together with RxCommand
from the rx_command
package.
It starts running as soon as an item with isExecuting==true
is received until isExecuting==true
is received.
To react on other possible states (data, no data, error
) that can be emitted it offers three option Builder
methods
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- RxLoader
Constructors
-
RxLoader({Key? key, Key? spinnerKey, required Stream<
CommandResult< commandResults, TargetPlatform? platform, double radius = 20.0, Color? backgroundColor, double? value, Animation<dynamic, R> >Color> ? valueColor, double strokeWidth = 4.0, RxBuilder<R> ? dataBuilder, PlaceHolderBuilder? placeHolderBuilder, ErrorBuilder<Exception> ? errorBuilder}) -
Creates a new
RxLoader
instance commandResults :Stream<CommandResult<dynamic, R>>
or aRxCommand<dynamic, R>
that issuesCommandResults
platform : defines platform style of the Spinner. If this is null or not provided the style of the current platform will be used radius : radius of the Spinner dataBuilder : Builder that will be called as soon as an event with data is received. It will get passed thedata
feeld of the CommandResult. If this is null aContainer
will be created instead. placeHolderBuilder : Builder that will be called as soon as an event withdata==null
is received. If this is null aContainer
will be created instead. dataBuilder : Builder that will be called as soon as an event with anerror
is received. It will get passed theerror
feeld of the CommandResult. If this is null aContainer
will be created instead. spinnerKey Widget key of the Spinner Widget of the RxLoader. This can be usefull if you want to check in UI Tests if the Spinner is visible. all other parameters please see https://docs.flutter.io/flutter/material/CircularProgressIndicator-class.html they are ignored if the platform style is iOS.const
Properties
- backgroundColor → Color?
-
final
-
commandResults
→ Stream<
CommandResult< dynamic, R> > -
final
-
dataBuilder
→ RxBuilder<
R> ? -
final
-
errorBuilder
→ ErrorBuilder<
Exception> ? -
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- placeHolderBuilder → PlaceHolderBuilder?
-
final
- platform → TargetPlatform?
-
final
- radius → double
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- spinnerKey → Key?
-
final
- strokeWidth → double
-
final
- value → double?
-
final
-
valueColor
→ Animation<
Color> ? -
final
Methods
-
createElement(
) → StatefulElement -
Creates a StatefulElement to manage this widget's location in the tree.
inherited
-
createState(
) → _RxLoaderState -
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}) → 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