RxLoader<T> class
Spinner/Busyindicator that reacts on the output of a Stream<CommandResult<T>>
. 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, nodata, error
) that can be emitted it offers three option Builder
methods
Constructors
-
RxLoader({Key key, Key spinnerKey, Stream<
CommandResult< commandResults, TargetPlatform platform, double radius: 20.0, Color backgroundColor, double value, Animation<T> >Color> valueColor, double strokeWidth: 4.0, BuilderFunction<T> dataBuilder, BuilderFunction1 placeHolderBuilder, BuilderFunction<Exception> errorBuilder }) -
Creates a new
RxLoader
instancecommandResults
:Stream<CommandResult<T>>
or aRxCommand<T>
that issuesCommandResults
platform
: defines platorm style of the Spinner. If this is null or not provided the style of the current platform will be usedradius
: 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< T> > -
final
-
dataBuilder
→ BuilderFunction<
T> -
final
-
errorBuilder
→ BuilderFunction<
Exception> -
final
- placeHolderBuilder → BuilderFunction1
-
final
- platform → TargetPlatform
-
final
- radius → double
-
final
- spinnerKey → Key
-
final
- strokeWidth → double
-
final
- value → double
-
final
-
valueColor
→ Animation<
Color> -
final
- hashCode → int
-
The hash code for this object. [...]
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
-
createState(
) → _RxLoaderState - Creates the mutable state for this widget at a given location in the tree. [...]
-
createElement(
) → StatefulElement -
Creates a
StatefulElement
to manage this widget's 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 toStringDeep. [...]
inherited
-
toString(
{DiagnosticLevel minLevel: DiagnosticLevel.debug }) → String -
Returns 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 ==(
dynamic other) → bool -
The equality operator. [...]
inherited