Singleton manager for navigation operations. This class provides a centralized interface for navigation operations and manages the router delegate and route information parser.
Properties
Gets the singleton instance of NavigationManager. Throws an exception if init() has not been called.
The router delegate managing navigation.
routeInformationParser
DefaultRouteInformationParser
The route information parser.
Stream of current route changes.
The current route, or null if no route is active.
The current list of routes in the navigation stack.
Sets the callback for customizing the route stack.
setInitialRouteFunction
DefaultRoute Function(Uri initialRoute)?
Sets the function to determine the initial route from a URI.
setInitialRoutePathFunction
String Function(Uri initialRoute)?
Sets the function to determine the initial route path from a URI.
Methods
init
static NavigationManager init({
required BaseRouterDelegate mainRouterDelegate,
required DefaultRouteInformationParser routeInformationParser
})
NavigationManager.instance.
mainRouterDelegate
BaseRouterDelegate
required
The router delegate to use.
routeInformationParser
DefaultRouteInformationParser
required
The route information parser to use.
push
Future<dynamic> push(
String name, {
Map<String, String>? queryParameters,
Object? arguments,
Map<String, dynamic> data = const {},
Map<String, String> pathParameters = const {},
bool apply = true
})
The route name or path to push.
Query parameters for the route.
Arguments to pass to the route.
data
Map<String, dynamic>
default:"{}"
Global data associated with the route.
pathParameters
Map<String, String>
default:"{}"
Path parameters for the route.
Whether to apply changes immediately.
pushRoute
Future<dynamic> pushRoute(DefaultRoute route, {bool apply = true})
Whether to apply changes immediately.
pop
void pop([dynamic result, bool apply = true, bool all = false])
Result to return to the previous route.
Whether to apply changes immediately.
Whether to pop all routes.
popUntil
void popUntil(
String name, {
bool apply = true,
bool all = false,
bool inclusive = false
})
The route name to pop until.
Whether to apply changes immediately.
Whether to allow popping all routes.
Whether to include the target route in the pop.
popUntilRoute
void popUntilRoute(
PopUntilRouteFunction popUntilRouteFunction, {
bool apply = true,
bool all = false,
bool inclusive = false
})
popUntilRouteFunction
PopUntilRouteFunction
required
Function that returns true to stop popping.
Whether to apply changes immediately.
Whether to allow popping all routes.
Whether to include the target route in the pop.
pushAndRemoveUntil
Future<dynamic> pushAndRemoveUntil(
String name,
String routeUntilName, {
Map<String, String>? queryParameters,
Object? arguments,
Map<String, dynamic> data = const {},
Map<String, String> pathParameters = const {},
bool apply = true,
bool inclusive = false
})
pushAndRemoveUntilRoute
Future<dynamic> pushAndRemoveUntilRoute(
DefaultRoute route,
PopUntilRouteFunction popUntilRouteFunction, {
bool apply = true,
bool inclusive = false
})
remove
void remove(String name, {bool apply = true})
removeRoute
void removeRoute(DefaultRoute route, {bool apply = true})
pushReplacement
Future<dynamic> pushReplacement(
String name, {
Map<String, String>? queryParameters,
Object? arguments,
Map<String, dynamic> data = const {},
Map<String, String> pathParameters = const {},
dynamic result,
bool apply = true
})
pushReplacementRoute
Future<dynamic> pushReplacementRoute(
DefaultRoute route,
[dynamic result, bool apply = true]
)
removeBelow
void removeBelow(String name, {bool apply = true})
removeRouteBelow
void removeRouteBelow(DefaultRoute route, {bool apply = true})
removeAbove
void removeAbove(String name, {bool apply = true})
removeRouteAbove
void removeRouteAbove(DefaultRoute route, {bool apply = true})
removeGroup
void removeGroup(String name, {bool apply = true, bool all = false})
replace
void replace(
String oldName, {
String? newName,
DefaultRoute? newRoute,
Map<String, dynamic>? data,
bool apply = true
})
replaceRoute
void replaceRoute(DefaultRoute oldRoute, DefaultRoute newRoute, {bool apply = true})
replaceBelow
void replaceBelow(String anchorName, String name, {bool apply = true})
replaceRouteBelow
void replaceRouteBelow(DefaultRoute anchorRoute, DefaultRoute newRoute, {bool apply = true})
set
void set(List<String> names, {bool apply = true})
setRoutes
void setRoutes(List<DefaultRoute> routes, {bool apply = true})
setBackstack
void setBackstack(List<String> names, {bool apply = true})
setBackstackRoutes
void setBackstackRoutes(List<DefaultRoute> routes, {bool apply = true})
setOverride
void setOverride(Page Function(String name) pageBuilder, {bool apply = true})
removeOverride
void removeOverride({bool apply = true})
setQueryParameters
void setQueryParameters(Map<String, String> queryParameters, {bool apply = true})
setOverlay
void setOverlay(Page Function(String name) pageBuilder, {bool apply = true})
removeOverlay
void removeOverlay({bool apply = true})
navigate
void navigate(BuildContext context, Function function)
neglect
void neglect(BuildContext context, Function function)
apply
Applies pending navigation changes.
clear
Clears the navigation stack.
pauseNavigation
void pauseNavigation({Page Function(String name)? pageBuilder})
resumeNavigation is called. Useful for forcing delayed navigation until an async operation completes.
pageBuilder
Page Function(String name)?
Optional custom loading page builder.
resumeNavigation
Resumes navigation and removes page overrides. Calls removeOverride under the hood. Has no effect if pauseNavigation has not been called.
nested
List<Widget> nested({
required BuildContext context,
required List<NavigationData> routes,
bool removeDuplicates = true
})
routes
List<NavigationData>
required
List of NavigationData defining the nested routes.
Whether to remove duplicate widgets.