NavigatorContainer<T, N extends NavChildState> class
A container that animates between various children as the current key changes, with nested navigator-like animations.
The animation is based on the given transitionBuilder which defaults to a vertical shared axis transition.
This widget is mainly a container class with no navigation logic or
components. It can be used in conjunction with nested navigator-like
tools such as the StatefulShellRoute in go_router. It is also used
internally by NestedNavigatorBuilder which implements the
navigator-related components.
- Inheritance
-
- Object
- DiagnosticableTree
- Widget
- StatefulWidget
- NavigatorContainer
Constructors
-
Creates a raw navigator container that navigates between the
children built by the various
buildersas thecurrentKeychanges.const
Properties
-
builders
→ Map<
T, NavWidgetBuilder< T, N> > -
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
- 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< NavigatorContainer< T, N> > -
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
Static Methods
-
indexed(
{Key? key, required int currentIndex, NestedTransitionBuilder transitionBuilder = _defaultTransitionBuilder, required List< Widget> children}) → NavigatorContainer<int, NavChildState> -
Creates a navigator container using a list of
children. -
map<
T> ({Key? key, required T currentKey, NestedTransitionBuilder transitionBuilder = _defaultTransitionBuilder, required Map< T, Widget> children}) → NavigatorContainer<T, NavChildState> - Creates a navigator container using a map of keys to a child.