NavigationPlugin class abstract

Inheritance

• Object
• Plugin
• NavigationPlugin

Implementers

• DefaultNavigationPlugin

Constructors

NavigationPlugin({required String name, required String title})

Properties

featureRedirects → RedirectRegistry

Redirects contributed by features through FeatureDescriptor.redirects.

final

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

instance → GoRouter

no setter

name → String

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

title → String

final, inherited

Methods

appendInitialRoutes(List<RouteBase> routes) → void

appendRoutes(List<RouteBase> routes) → void

dispose() → Future<void>

inherited

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

goHome() → void

Navigates to homeLocation.

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

init() → Future<void>

inherited

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

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

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

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

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

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

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

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

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

replaceRoutes(List<RouteBase> routes) → void

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.

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

catchAllPath → const String

The path of a catch-all route. A feature can contribute one GoRoute with this path to handle every location no other route matches; the router always places it last. Without one, unmatched locations show the not-found RouteFailureView.