StoreBuilder<S> class

Build a Widget by passing the Store directly to the build function.

Generally, it's considered best practice to use the StoreConnector and to build a ViewModel specifically for your Widget rather than passing through the entire Store, but this is provided for convenience when that isn't necessary.

Inheritance

Constructors

StoreBuilder({Key key, @required ViewModelBuilder<Store<S>> builder, OnInitCallback<S> onInit OnDisposeCallback<S> onDispose bool rebuildOnChange: true, OnWillChangeCallback<Store<S>> onWillChange, OnDidChangeCallback<Store<S>> onDidChange OnInitialBuildCallback<Store<S>> onInitialBuild })
Create's a Widget based on the Store.
const

Properties

builder ViewModelBuilder<Store<S>>
Builds a Widget using the BuildContext and your Store.
final
onDidChange OnDidChangeCallback<Store<S>>
A function that will be run on State change, after the Widget is built. [...]
final
onDispose OnDisposeCallback<S>
A function that will be run when the StoreBuilder is removed from the Widget Tree. [...]
final
onInit OnInitCallback<S>
A function that will be run when the StoreConnector is initially created. It is run in the State.initState method. [...]
final
onInitialBuild OnInitialBuildCallback<Store<S>>
A function that will be run after the Widget is built the first time. [...]
final
onWillChange OnWillChangeCallback<Store<S>>
A function that will be run on State change, before the Widget is built. [...]
final
rebuildOnChange → bool
Indicates whether or not the Widget should rebuild when the Store emits an onChange event.
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

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. [...]
@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.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