StackRouter class

A router for displaying and routing to/from widgets using an IndexedStack.

Inheritance

Constructors

StackRouter({required List<StackRoute> builder(StackRouterState router), String? initialRoute, List<String> initialHistory = const [], StackRouterController? controller, void onRouteChange(String route)?, bool notifySystemNavigator = true, dynamic key})
const

Properties

builder List<StackRoute> Function(StackRouterState router)
The builder for the router that returns a list of the full set of stack routes.
final
controller StackRouterController?
The controller for the stack router used to imperatively change routes and interact with the route snack bars.
final
hashCode int
The hash code for this object.
no setterinherited
initialHistory List<String>
final
initialRoute String?
The initial route to display.
final
key Key?
Controls how one widget replaces another widget in the tree.
finalinherited
notifySystemNavigator bool
Whether route changes should notify the system navigator to trigger URI updates on Flutter web.
final
onRouteChange → void Function(String route)?
final
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

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