DefaultNavigationPlugin class final

Inheritance

• Object
• Plugin
• NavigationPlugin
• DefaultNavigationPlugin

Constructors

DefaultNavigationPlugin({bool urlReflectsImperativeAPIs = false, GoRouterRedirect? redirect, RouterUrlStyle? urlStyle})

Creates the GoRouter-based navigation plugin.

Properties

featureRedirects → RedirectRegistry

Redirects contributed by features through FeatureDescriptor.redirects.

final, inherited

hashCode → int

The hash code for this object.

no setter, inherited

homeLocation ↔ String

The location of the home route, used by error views to offer a way back. Set by the platform from runApp(homeLocation: ...).

getter/setter pair, inherited

instance → GoRouter

no setter, override

name → String

final, inherited

redirect → GoRouterRedirect?

The global redirect for this router, run before every feature redirect.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

title → String

final, inherited

Methods

appendInitialRoutes(List<RouteBase> routes) → void

override

appendRoutes(List<RouteBase> routes) → void

override

dispose() → Future<void>

override

go(String location, {Object? extra}) → void

override

goHome() → void

Navigates to homeLocation.

inherited

goNamed(String name, {Map<String, String> pathParameters = const <String, String>{}, Map<String, dynamic> queryParameters = const <String, dynamic>{}, Object? extra}) → void

override

init() → Future<void>

override

initRouter({String? initialLocation, required List<RouteBase> routes, required GlobalKey<NavigatorState> rootNavigatorKey}) → void

override

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

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

override

push<T extends Object?>(String location, {Object? extra}) → Future<T?>

override

pushNamed<T extends Object?>(String name, {Map<String, String> pathParameters = const <String, String>{}, Map<String, dynamic> queryParameters = const <String, dynamic>{}, Object? extra}) → Future<T?>

override

pushReplacement<T extends Object?>(String location, {Object? extra}) → Future<T?>

override

pushReplacementNamed<T extends Object?>(String name, {Map<String, String> pathParameters = const <String, String>{}, Map<String, dynamic> queryParameters = const <String, dynamic>{}, Object? extra}) → Future<T?>

override

replace<T extends Object?>(String location, {Object? extra}) → Future<T?>

override

replaceNamed<T extends Object?>(String name, {Map<String, String> pathParameters = const <String, String>{}, Map<String, dynamic> queryParameters = const <String, dynamic>{}, Object? extra}) → Future<T?>

override

replaceRoutes(List<RouteBase> routes) → void

override

toString() → String

A string representation of this object.

inherited

watchRedirectTriggers(VoidCallback refresh) → VoidCallback

Calls refresh whenever a feature redirect's trigger fires: one of its refreshOn events is emitted, or its listenable notifies. Also calls refresh when the set of redirects changes. Returns a function that stops watching.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Static Methods

enableURLReflectsImperativeAPIs() → void

setRouterRedirect(GoRouterRedirect redirect) → void

useHashStrategy() → void

usePathStrategy() → void