ff_annotation_route_library library

Classes

ExtendedRouteAware
ExtendedRouteObserver
ExtendedRouteObserver is a utility class that extends the functionality of Flutter's built-in RouteObserver. It allows for more advanced route management and tracking in the navigation stack. This class maintains an internal list of active routes and provides several utility methods for route inspection and manipulation.
FFArgumentImport
Annotation of argument import
FFAutoImport
Annotation of auto import
FFConvert
FFNavigatorObserver
The NavigatorObserver to listen route change
FFPage<T>
Navigator 2.0
FFRoute
Annotation to generate route
FFRouteInformationParser
A delegate that is used by the Router widget to parse a route information into a configuration of type RouteSettings.
FFRouterDelegate
A delegate that is used by the Router widget to build and configure a navigating widget.
FFRouteSettings
Navigator 1.0
FFTransparentPageRoute<T>
Transparent Page Route
The Navigator static method with interceptor.
RouteInterceptor
RouteInterceptorManager
Manages route interceptors globally and per route basis.
RouteInterceptResult
Represents the result of a route interception.
RouteLifecycleState<T extends StatefulWidget>

Enums

PageRouteType
RouteInterceptAction
Represents the possible actions a route interceptor can take after being invoked during the route interception process.

Constants

argumentNames → const String
constructorName → const String
ffRouteFileImport → const String

Functions

asT<T extends Object?>(dynamic value, [T? defaultValue]) → T?
onGenerateRoute({required RouteSettings settings, required GetRouteSettings getRouteSettings, Map<String, dynamic>? arguments, RouteSettingsWrapper? routeSettingsWrapper, PageBuilder? notFoundPageBuilder, FFErrorWidgetBuilder? errorWidgetBuilder}) Route
onGenerateRoute for Navigator 1.0

Typedefs

FFErrorWidgetBuilder = Widget Function(BuildContext context, Object error, StackTrace stackTrace)
The builder return the error page
GetRouteSettings = FFRouteSettings Function({Map<String, dynamic>? arguments, required String name, PageBuilder? notFoundPageBuilder})
The getRouteSettings method which is created by ff_annotation_route
FFRouterDelegate.navigatorWrapper
PageBuilder = Widget Function()
The builder return the page
PagePredicate = bool Function(FFPage page)
Signature for the FFRouterDelegate.popUntil predicate argument.
PageWrapper = FFPage<T> Function<T>(FFPage<T> pageRoute)
FFRouterDelegate.pageWrapper, re-define FFPage in this call back
RouteChange = void Function(Route? newRoute, Route? oldRoute)
Route change call back FFNavigatorObserver.routeChange
RouteSettingsWrapper = FFRouteSettings Function(FFRouteSettings pageRoute)
onGenerateRoute, re-define FFRouteSettings in this call back