RouterState class

A router state.

Keeps router state.

Mixed in types

• ChangeNotifier

Constructors

RouterState({required List<RouteDefinition> routeDefinitions, required String notFoundPath, required GlobalKey<NavigatorState> navigatorKey})

Creates a RouterState.

Properties

currentPath → String

Gets the current path.

no setter

eventStream → ValueStream<RouterEvent>

Router event stream.

no setter

hashCode → int

The hash code for this object.

no setter, inherited

hasListeners → bool

Whether any listeners are currently registered.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

addListener(VoidCallback listener) → void

Register a closure to be called when the object changes.

inherited

dispose() → void

Discards any resources used by the object. After this is called, the object is not in a usable state and should be discarded (calls to addListener will throw after the object is disposed).

override

findWidget<T extends Widget>() → T?

Returns the Widget of the nearest Page the is an instance of the given type T.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

notifyListeners() → void

Call all the registered listeners.

inherited

pop<T extends Object?>([T? result]) → Future<bool>

Pops the top-most route.

popUntil(bool predicate(PageWrapper pageWrapper)) → void

Pops all the previous routes until the predicate returns true.

push(String path, {String? id}) → void

Pushes a new page by path.

remove(String path) → void

Removes a route by path.

removeAllAndPush(String path, {String? id}) → void

Removes all routes then pushes a new page by path.

removeListener(VoidCallback listener) → void

Remove a previously registered closure from the list of closures that are notified when the object changes.

inherited

removeUntilAndPush(bool predicate(PageWrapper pageWrapper), String path, {String? id}) → void

Removes all the previous routes until the predicate returns true.

replace(String path, {String? id}) → void

Replace the current route by a new one by path.

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited