NavigationBranchContainer class

A bounded alternative to an IndexedStack for stateful shell navigators.

Supply this from StatefulShellRoute.navigatorContainerBuilder. The app owns branch identity and the retention limit; this widget owns only mount lifetime. The active branch and most recently used branches stay mounted. Eviction disposes widget state, focus and subscriptions; go_router retains its route match history and can reconstruct the navigator on the next visit.

Inheritance

• Object
• DiagnosticableTree
• Widget
• StatefulWidget
• NavigationBranchContainer

Constructors

NavigationBranchContainer({Key? key, required int currentIndex, required List<Widget> children, required int maxRetainedBranches})

const

Properties

children → List<Widget>

final

currentIndex → int

final

hashCode → int

The hash code for this object.

no setter, inherited

key → Key?

Controls how one widget replaces another widget in the tree.

final, inherited

maxRetainedBranches → int

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

createElement() → StatefulElement

Creates a StatefulElement to manage this widget's location in the tree.

inherited

createState() → State<NavigationBranchContainer>

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, int wrapWidth = 65}) → 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