FlowBuilder<T> class

FlowBuilder abstracts navigation and exposes a declarative routing API based on a state.

By default completing a flow results in the flow being popped from the navigation stack with the resulting flow state.

To override the default behavior, provide an implementation for onComplete.

FlowBuilder<MyFlowState>(
  state: MyFlowState.initial(),
  onGeneratePages: (state, pages) {...},
  onComplete: (state) {
    // do something when flow is completed...
  }
)
Inheritance

Constructors

FlowBuilder({required OnGeneratePages<T> onGeneratePages, T? state, ValueSetter<T>? onComplete, FlowController<T>? controller, List<NavigatorObserver> observers = const <NavigatorObserver>[], Clip clipBehavior = Clip.hardEdge, Key? key})
FlowBuilder abstracts navigation and exposes a declarative routing API based on a state.
const

Properties

clipBehavior → Clip
In cases where clipping is not desired, consider setting this property to Clip.none.
final
controller → FlowController<T>?
Optional FlowController which will be used in the current flow. If not provided, a FlowController instance will be created internally.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
observers → List<NavigatorObserver>
A list of NavigatorObserver for this FlowBuilder.
final
onComplete → ValueSetter<T>?
Optional ValueSetter<T> which is invoked when the flow has been completed with the final flow state.
final
onGeneratePages → OnGeneratePages<T>
Builds a List<Page> based on the current state.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → T?
The state of the flow.
final

Methods

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