PageStackNavigator class

Provides a Navigator that shows pages from a PageStack.

This widget listens to that stack, and updates the navigator when the pages change.

Inheritance

Constructors

PageStackNavigator({Key? key, required PageStack stack, TransitionDelegate transitionDelegate = const DefaultTransitionDelegate<dynamic>(), List<NavigatorObserver> observers = const [], Key? navigatorKey})
Provides a Navigator that shows pages from a PageStack.
const
PageStackNavigator.builder({Key? key, required PageStack stack, required Iterable<Page> builder(List<Page>)?, TransitionDelegate transitionDelegate = const DefaultTransitionDelegate<dynamic>(), List<NavigatorObserver> observers = const [], Key? navigatorKey})
Provides a Navigator that shows pages from a PageStack.
const

Properties

builder → (Iterable<Page> Function(List<Page>)?)
A function that can filter or transform the list of pages from the stack.
final
hashCode → int
The hash code for this object.
no setterinherited
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
An optional key that's passed to the Navigator widget.
final
observers → List<NavigatorObserver>
A list of NavigatorObserver that will be passed to the Navigator.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
stack → PageStack
The stack of pages to show in the Navigator.
final
transitionDelegate → TransitionDelegate
A delegate that decides how pages are animated when they're added or removed from the Navigator.
final

Methods

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

of(BuildContext context) → PageStackNavigatorState
Retrieves the nearest PageStackNavigatorState ancestor.