sunny_fluro library

Classes

AppPageRoute<R, P extends RouteParams>

An app route:

AppRoute<R, P extends RouteParams>

Base class for app routes. See AppPageRoute and CompletableAppRoute

AppRouteMatch<R, P extends RouteParams>

Represents the combination of the route definition AppRoute as well as the specific parameters to create an instance of that route.

CompletableAppRoute<R, P extends RouteParams>

The details of the route are opaque, all the transitions are managed internally and a future is returned.

CompletableRouteAdapter<R>

Converts a plain future to a route. When this route is pushed, it makes a call back to the invoker, passing the BuildContext. When that future is completed, this route is automatically popped.

DefaultRouteParams

DefaultRouterFactory

FRouter

InternalArgs

InvalidRouteDefinition

pathParam

PathRouteSettings

A more advanced route settings that lets us provide more context when routing

route

routeParams

RouteParams

RouterFactory

This class is responsible for providing a RouteCreator for a static AppRoute. You would use this if you want/ need to fully customize the Route, or if you use a specialized Route subclass.

routes

RouteTree

RouteTreeNode

RouteTreeNodeMatch

UriTemplateAppPageRoute<R, P extends RouteParams>

UriTemplateCompletableAppRoute<R, P extends RouteParams>

Enums

ParameterExtractorType

How path parameters are extracted

RouteTreeNodeType

TransitionType

Extensions

AppRouteCastingExtensions on AppRoute<R, P>?

CompletableHandlerCastExt on CompletableHandler<R, P>

ParamConverterCastExt on ParameterConverter<P>

ParameterExtractorTypeExtensions on ParameterExtractorType?

RouteParamsExt on RouteParams

RouterBaseExtensions on FRouter

RouterExtensions on FRouter

RouteTreeNodePathExt on RouteTreeNode

RouteTreePathExt on RouteTree

StringPathExt on String?

ToRouteTitleCastExt on ToRouteTitle<P>

WidgetHandlerCastExt on WidgetHandler<R, P>

Constants

missingRouteName → const String

Properties

defaultConverter → ParameterConverter<RouteParams>

final

newLinesPattern → RegExp

final

noopSendRoute → SendRoute

no setter

typeParameters → RegExp

final

Functions

calculateRoute(dynamic input) → String?

sanitizeParams(Map<String, dynamic>? params) → Map<String, dynamic>

standardTransitionsBuilder(TransitionType? transitionType) → RouteTransitionsBuilder

Typedefs

CompletableHandler<R, P extends RouteParams> = Future<R> Function(BuildContext context, P parameters, SendRoute sendRoute)

Used by CompletableAppRoute

FutureCallback<T> = Future<T> Function(BuildContext context)

NavigatorOf = NavigatorState Function(BuildContext context, bool useRootNavigator)

Retrieves the navigator state for this router

ParameterConverter<P extends RouteParams> = P Function(dynamic rawInput)

Converts dynamic map arguments to a known type P

RouteCreator<T, P extends RouteParams> = Route<T> Function(String? name, P parameters)

RouteExecutor<R> = Future<R> Function()

SendRoute = Future Function(BuildContext context, AppRoute<dynamic, RouteParams> newRoute, RouteParams params)

Used as a higher-order routing function, that dispatches the route immediately

ToRouteTitle<P> = String? Function(P? parameters)

Given parameters, produces a title for this route

ToRouteUri = String Function(dynamic parameters)

Given parameters, produces a link back to this route

ValueReader = dynamic Function(String name)

WidgetHandler<R, P> = Widget Function(BuildContext context, P parameters)

Used by AppPageRoute Creates a widget, given P parameters

Exceptions / Errors

RouteNotFoundException