RouteNavigator class abstract

High level navigation operations over the current route tree.

RouteNavigator exposes familiar push, pop and replace primitives, as well as helpers to update a node's arguments, extra data and children.

Implementers

Constructors

RouteNavigator()

Properties

hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

canPop() → bool
Determines if there are any routes that can be popped from the stack.
maybePop() → void
Remove the top route from the navigation stack. If there is only one route in the stack, nothing will happen.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
pop() → void
Remove one of the top routes from the navigation stack. If there is only one route in the stack, it throws a StateError.
popAll() → void
Remove all routes from the navigation stack except for the first one. If there is only one route in the stack, nothing will happen.
popUntil(RouteNodePredicate<RouteNode> predicate) → void
Pops routes off the stack until a route satisfying the predicate is reached.
popWhere(RouteNodePredicate<RouteNode> predicate) → void
Removes a route from the stack if the route matches the predicate condition.
push(YxRoute route, {Map<String, String>? arguments, Map<String, Object?>? extra}) → void
Pushes a new route onto the navigation stack.
pushAll(List<({Map<String, String>? arguments, Map<String, Object?>? extra, YxRoute route})> routes) → void
Pushes multiple routes onto the navigation stack.
pushAndRemoveUntil(YxRoute route, RouteNodePredicate<RouteNode> predicate, {Map<String, String>? arguments, Map<String, Object?>? extra}) → void
Pushes a new route onto the stack and removes all routes until a predicate condition is met.
pushNode(RouteNode node) → void
Pushes a new node onto the navigation stack.
pushReplacement(YxRoute route, {Map<String, String>? arguments, Map<String, Object?>? extra}) → void
Replaces the current route with a new route.
setArguments(Map<String, String> arguments) → void
Sets the arguments for the current route.
setChildren(Iterable<RouteNode> children) → void
Sets the children for the current route.
setExtra(Map<String, Object?> extra) → void
Sets the extra data for the current route.
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited