createMaterialRouter function

RouteDefinerRouter createMaterialRouter({
  1. required Iterable<RouteDefiner> routes,
  2. String initialRoute = '/',
  3. String appTitle = '',
  4. Widget loadingBuilder(
    1. CurrentRoute
    )?,
  5. Widget deniedBuilder(
    1. BuildContext,
    2. CurrentRoute
    )?,
  6. Widget notFoundBuilder(
    1. BuildContext,
    2. RouteState
    )?,
  7. Widget errorBuilder(
    1. BuildContext,
    2. RouteFailure,
    3. VoidCallback
    )?,
  8. void onError(
    1. RouteFailure
    )?,
  9. Duration? resolutionTimeout,
  10. int redirectLimit = 5,
  11. RouteOptions defaultRouteOptions = const RouteOptions(),
  12. DefinedRouteFactory? routeFactory,
  13. DefinedPageRouteFactory? pageRouteFactory,
  14. GlobalKey<NavigatorState>? navigatorKey,
  15. List<NavigatorObserver> observers = const [],
  16. String? restorationScopeId,
  17. RouteArgumentsCodec argumentsCodec = const JsonRouteArgumentsCodec(),
  18. Listenable? refreshListenable,
  19. BackButtonDispatcher? backButtonDispatcher,
  20. int historyLimit = 0,
  21. NavigationDiagnostics? diagnostics,
})

Creates a router with the optional status pages and Material page behavior. Keep the returned router outside build and dispose it with its owner. All explicit constructor options remain available, including view overrides.

Implementation

RouteDefinerRouter createMaterialRouter({
  required Iterable<RouteDefiner<dynamic>> routes,
  String initialRoute = '/',
  String appTitle = '',
  Widget Function(CurrentRoute)? loadingBuilder,
  Widget Function(BuildContext, CurrentRoute)? deniedBuilder,
  Widget Function(BuildContext, RouteState)? notFoundBuilder,
  Widget Function(BuildContext, RouteFailure, VoidCallback)? errorBuilder,
  void Function(RouteFailure)? onError,
  Duration? resolutionTimeout,
  int redirectLimit = 5,
  RouteOptions defaultRouteOptions = const RouteOptions(),
  DefinedRouteFactory? routeFactory,
  DefinedPageRouteFactory? pageRouteFactory,
  GlobalKey<NavigatorState>? navigatorKey,
  List<NavigatorObserver> observers = const [],
  String? restorationScopeId,
  RouteArgumentsCodec argumentsCodec = const JsonRouteArgumentsCodec(),
  Listenable? refreshListenable,
  BackButtonDispatcher? backButtonDispatcher,
  int historyLimit = 0,
  NavigationDiagnostics? diagnostics,
}) =>
    RouteDefinerRouter(
      routes: routes,
      initialRoute: initialRoute,
      appTitle: appTitle,
      loadingBuilder: loadingBuilder ?? (_) => const LoadingPage(),
      deniedBuilder: deniedBuilder ?? (_, __) => const DeniedPage(),
      notFoundBuilder: notFoundBuilder ?? (_, __) => const NotFoundPage(),
      errorBuilder: errorBuilder ?? (_, __, retry) => ErrorPage(onRetry: retry),
      onError: onError,
      resolutionTimeout: resolutionTimeout,
      redirectLimit: redirectLimit,
      defaultRouteOptions: defaultRouteOptions,
      routeFactory: routeFactory,
      pageRouteFactory: pageRouteFactory,
      navigatorKey: navigatorKey,
      observers: observers,
      restorationScopeId: restorationScopeId,
      argumentsCodec: argumentsCodec,
      refreshListenable: refreshListenable,
      backButtonDispatcher: backButtonDispatcher,
      historyLimit: historyLimit,
      diagnostics: diagnostics,
    );