StreamBuilder<T> class
A f.StreamBuilder that displays a progress indicator while its connection state is waiting.
The widget provided by onData will only be displayed when the connection state is equal to f.ConnectionState.done or f.ConnectionState.active.
The progress indicator can be changed using the indicator parameter (defaults to a centered f.CircularProgressIndicator).
The following usage
// fluttils:
StreamBuilder<int>(
someStream,
builder: (_, data) => Text("value: $data"),
);
is equivalent to
// flutter:
StreamBuilder<int>(
stream: someStream,
builder: (_, snapshot) {
if (snapshot.connectionState == ConnectionState.waiting)
return Center(child: CircularProgressIndicator());
final int data = snapshot.data;
return Text("value: $data");
},
);
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatelessWidget
- StreamBuilder
Constructors
-
StreamBuilder(Stream<
T> stream, {required Widget onData(BuildContext, T), T? initialData, Widget onError(BuildContext, Object, StackTrace) = _onErrorDefault, Widget indicator = const f.Center(child: f.CircularProgressIndicator())}) -
Creates a StreamBuilder with some commonly used f.StreamBuilder
parameters.
const
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- indicator → Widget
-
final
- initialData → T?
-
final
- key → Key?
-
Controls how one widget replaces another widget in the tree.
finalinherited
- onData → Widget Function(BuildContext, T)
-
final
- onError → Widget Function(BuildContext, Object, StackTrace)
-
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
stream
→ Stream<
T> -
final
Methods
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
createElement(
) → StatelessElement -
Creates a StatelessElement to manage this widget's 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}) → 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