NestedNavigatorBuilder<T> class

Builds a stack of page-based navigators and displays the one associated with the given currentKey, in order to help fulfill the 'nested navigator with bottom nav bar' pattern.

A navigator with the list of pages associated with the given currentKey is displayed by default. As the current key changes, additional navigators are built lazily and animated into view.

Previously built navigators are animated away then kept offstage. Their state is still preserved even while not visible.

Inheritance

Constructors

NestedNavigatorBuilder({Key? key, required T currentKey, required NestedDidRemovePageCallback<T> onDidRemovePage, NestedTransitionBuilder transitionBuilder = NavigatorContainer._defaultTransitionBuilder, RestorationScopeIdCallback<T>? restorationScopeIdCallback, NavigatorObserversBuilder navObserversBuilder = _defaultNavObserversBuilder, required Map<T, PageListBuilder> builders})
const

Properties

builders → Map<T, PageListBuilder>
final
currentKey → T
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
final
onDidRemovePage → NestedDidRemovePageCallback<T>
final
restorationScopeIdCallback → RestorationScopeIdCallback<T>?
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transitionBuilder → NestedTransitionBuilder
final

Methods

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