config method

RouterConfig<UrlState> config({
  1. DeepLinkTransformer? deepLinkTransformer,
  2. DeepLinkBuilder? deepLinkBuilder,
  3. String? navRestorationScopeId,
  4. WidgetBuilder? placeholder,
  5. NavigatorObserversBuilder navigatorObservers = AutoRouterDelegate.defaultNavigatorObserversBuilder,
  6. bool includePrefixMatches = !kIsWeb,
  7. bool neglectWhen(
    1. String? location
    )?,
  8. bool rebuildStackOnDeepLink = false,
  9. Listenable? reevaluateListenable,
})

Returns a RouterConfig instead to be passed to MaterialApp.router

Implementation

RouterConfig<UrlState> config({
  DeepLinkTransformer? deepLinkTransformer,
  DeepLinkBuilder? deepLinkBuilder,
  String? navRestorationScopeId,
  WidgetBuilder? placeholder,
  NavigatorObserversBuilder navigatorObservers =
      AutoRouterDelegate.defaultNavigatorObserversBuilder,
  bool includePrefixMatches = !kIsWeb,
  bool Function(String? location)? neglectWhen,
  bool rebuildStackOnDeepLink = false,
  Listenable? reevaluateListenable,
}) {
  return RouterConfig(
    routeInformationParser: defaultRouteParser(
      includePrefixMatches: includePrefixMatches,
      deepLinkTransformer: deepLinkTransformer,
    ),
    routeInformationProvider: routeInfoProvider(
      neglectWhen: neglectWhen,
    ),
    backButtonDispatcher: RootBackButtonDispatcher(),
    routerDelegate: delegate(
      reevaluateListenable: reevaluateListenable,
      rebuildStackOnDeepLink: rebuildStackOnDeepLink,
      navRestorationScopeId: navRestorationScopeId,
      navigatorObservers: navigatorObservers,
      placeholder: placeholder,
      deepLinkBuilder: deepLinkBuilder,
    ),
  );
}