PageService class - page_service library

Constructors

PageService(): factory

Properties

hashCode → int: The hash code for this object.
no setterinherited
joinedLocation → String: no setter
navigationHistory → List<NavStep>: no setter
routeObserver → RouteObserver<PageRoute>: no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited

Methods

canPop() → bool: Available on PageService, provided by the NavigatorInheritanceServiceExt extension
Check if there is at least one active route to pop
init(NavPageServiceConfig config) → void: Initialize the NavService with configuration
launched(List<NavRouteInfo> routes) → Future<void>: Call this method when app is launched to restore or set initial routes
maybePop<T>([T? result]) → Future<bool>: Available on PageService, provided by the NavigatorInheritanceServiceExt extension
Pop the top-most route if possible
navigate(String path, {Map<String, dynamic>? extra, bool forcePush = false}) → void: If the path exists in the navigation history, navigate back to it. If not, push a new route.
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
persist() → Future<void>: Available on PageService, provided by the PersistenceServiceExt extension
Persists the current navigation history using the configured persistence handler
persistBase() → List<Map<String, dynamic>>: Available on PageService, provided by the PersistenceServiceExt extension
Persists the current navigation history to a serializable format Returns a list of maps containing path and extra data for each route
pop<T extends Object?>([T? result]) → void: Available on PageService, provided by the NavigatorInheritanceServiceExt extension
Pop the current route with animation
popAll() → void: Pop all routes with animation
popUntil(RoutePredicate predicate) → void: Available on PageService, provided by the NavigatorInheritanceServiceExt extension
Pops routes until the given predicate returns true
popUntilPath(String path) → void: Pops routes until the given path is reached
push<T>(String path, {Map<String, dynamic>? extra}) → Future<T?>: Available on PageService, provided by the NavigatorInheritanceServiceExt extension
Push a new route onto the navigator stack with animation
pushAll(List<NavRouteInfo> routeInfos) → void: Adds the corresponding pages to given routeInfos list to the _steps stack at once Similar to AutoRoute's pushAll method
pushAndRemoveUntil(String path, RoutePredicate predicate, {Map<String, dynamic>? extra}) → void: Available on PageService, provided by the NavigatorInheritanceServiceExt extension
Push a new route and remove routes until the given predicate returns true
pushReplacement(String path, {Map<String, dynamic>? extra}) → void: Available on PageService, provided by the NavigatorInheritanceServiceExt extension
Replace the current route with a new one with push animation
pushReplacementAll(List<NavRouteInfo> routeInfos) → void: Replace last route with new routes with push animation
removeAll() → void: Required call before call GoRouter's context.go()
replace(String path, {Map<String, dynamic>? extra}) → void: Available on PageService, provided by the NavigatorInheritanceServiceExt extension
Replace the current route with a new one without animation
replaceAll(List<NavRouteInfo> routeInfos) → void: Replace all existing routes with new routes with push animation
restore() → Future<void>: Available on PageService, provided by the PersistenceServiceExt extension
Restores navigation history using the configured persistence handler
restoreBase(dynamic data) → void: Available on PageService, provided by the PersistenceServiceExt extension
Restores navigation history from persisted data data should be a List<Map<String, dynamic>> containing route information
toString() → String: A string representation of this object.
inherited

Operators

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

Static Properties

instance → PageService: final
page → PageService: no setter