NavigationService class

NavigationService is the core class that is used to get the actual Navigation instance

Inheritance
Mixed-in types

Properties

canPop → bool
Navigation.canPop is used to know when the page can be popped
no setteroverride
currentConfiguration → String?
Called by the Router when it detects a route information may have changed as a result of rebuild.
no setteroverride
hashCode → int
The hash code for this object.
no setterinherited
hasListeners → bool
Whether any listeners are currently registered.
no setterinherited
The key used for retrieving the current navigator.
final
observers ↔ List<NavigatorObserver>
latefinal
pages ↔ List<NavigationPage>
latefinal
restorationScopeId ↔ String?
latefinal
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transitionDuration ↔ Duration
latefinal
transitionsBuilder ↔ RouteTransitionsBuilder?
latefinal
unknownPage ↔ NavigationPage?
latefinal

Methods

addListener(VoidCallback listener) → void
Register a closure to be called when the object changes.
inherited
build(BuildContext context) → Widget
Called by the Router to obtain the widget tree that represents the current state.
override
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).
inherited
initialize(String path) → void
This is used internally
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
notifyListeners() → void
Call all the registered listeners.
inherited
pop<T>([T? result]) → void
Navigation.pop is used to navigate back to the previous screen
override
popAndPush<T, R>(String page, {T? result, Object? data}) → Future<R?>
Navigation.popAndPush is used to navigate back to the previous screen and navigate to another screen
override
popRoute() → Future<bool>
Called by the Router when the Router.backButtonDispatcher reports that the operating system is requesting that the current route be popped.
inherited
popUntil(bool predicate(PageSettings)) → void
Navigation.popUntil is used to navigate back until the condition returns true
override
push<T>(String page, [Object? data]) → Future<T?>
Navigation.push is used to navigate to another screen maintaining the previous screen
override
pushAndReplaceUntil<T>(String page, bool predicate(PageSettings), [Object? data]) → Future<T?>
Navigation.pushAndReplaceUntil is used to navigate to another screen and replaces the previous screens until the condition returns true
override
pushReplacement<T>(String page, [Object? data]) → Future<T?>
Navigation.pushReplacement is used to navigate to another screen replacing the previous screen
override
pushToUnknownPage([bool shouldResetPages = true]) → void
Navigation.pushToUnknownPage is used to navigate to the unknown page
override
removeListener(VoidCallback listener) → void
Remove a previously registered closure from the list of closures that are notified when the object changes.
inherited
setInitialRoutePath(String configuration) → Future<void>
Called by the Router at startup with the structure that the RouteInformationParser obtained from parsing the initial route.
inherited
setNewRoutePath(String configuration) → Future<void>
Called by the Router when the Router.routeInformationProvider reports that a new route has been pushed to the application by the operating system.
override
setRestoredRoutePath(String configuration) → Future<void>
Called by the Router during state restoration.
inherited
toString() → String
A string representation of this object.
inherited

Operators

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

Static Properties

instance → Navigation
NavigationService.instance is the implementation of navigator 2.0
latefinal