BUIMaterialApp.router constructor

const BUIMaterialApp.router({
  1. Key? key,
  2. GlobalKey<ScaffoldMessengerState>? scaffoldMessengerKey,
  3. RouteInformationProvider? routeInformationProvider,
  4. RouteInformationParser<Object>? routeInformationParser,
  5. RouterDelegate<Object>? routerDelegate,
  6. RouterConfig<Object>? routerConfig,
  7. BackButtonDispatcher? backButtonDispatcher,
  8. TransitionBuilder? builder,
  9. String title = '',
  10. GenerateAppTitle? onGenerateTitle,
  11. Color? color,
  12. ThemeData? theme,
  13. ThemeData? darkTheme,
  14. ThemeData? highContrastTheme,
  15. ThemeData? highContrastDarkTheme,
  16. ThemeMode? themeMode = ThemeMode.system,
  17. Duration themeAnimationDuration = kThemeAnimationDuration,
  18. Curve themeAnimationCurve = Curves.linear,
  19. Locale? locale,
  20. Iterable<LocalizationsDelegate>? localizationsDelegates,
  21. LocaleListResolutionCallback? localeListResolutionCallback,
  22. LocaleResolutionCallback? localeResolutionCallback,
  23. Iterable<Locale> supportedLocales = const <Locale>[Locale('en', 'US')],
  24. bool debugShowMaterialGrid = false,
  25. bool showPerformanceOverlay = false,
  26. bool checkerboardRasterCacheImages = false,
  27. bool checkerboardOffscreenLayers = false,
  28. bool showSemanticsDebugger = false,
  29. bool debugShowCheckedModeBanner = false,
  30. Map<ShortcutActivator, Intent>? shortcuts,
  31. Map<Type, Action<Intent>>? actions,
  32. String? restorationScopeId,
  33. ScrollBehavior? scrollBehavior,
})

Creates a BUIMaterialApp that uses the Router instead of a Navigator.

If the routerConfig is provided, the other router related delegates, routeInformationParser, routeInformationProvider, routerDelegate, and backButtonDispatcher, must all be null.

Implementation

const BUIMaterialApp.router({
  super.key,
  this.scaffoldMessengerKey,
  this.routeInformationProvider,
  this.routeInformationParser,
  this.routerDelegate,
  this.routerConfig,
  this.backButtonDispatcher,
  this.builder,
  this.title = '',
  this.onGenerateTitle,
  this.color,
  this.theme,
  this.darkTheme,
  this.highContrastTheme,
  this.highContrastDarkTheme,
  this.themeMode = ThemeMode.system,
  this.themeAnimationDuration = kThemeAnimationDuration,
  this.themeAnimationCurve = Curves.linear,
  this.locale,
  this.localizationsDelegates,
  this.localeListResolutionCallback,
  this.localeResolutionCallback,
  this.supportedLocales = const <Locale>[Locale('en', 'US')],
  this.debugShowMaterialGrid = false,
  this.showPerformanceOverlay = false,
  this.checkerboardRasterCacheImages = false,
  this.checkerboardOffscreenLayers = false,
  this.showSemanticsDebugger = false,
  this.debugShowCheckedModeBanner = false,
  this.shortcuts,
  this.actions,
  this.restorationScopeId,
  this.scrollBehavior,
})  : assert(routerDelegate != null || routerConfig != null),
      navigatorObservers = null,
      navigatorKey = null,
      onGenerateRoute = null,
      home = null,
      onGenerateInitialRoutes = null,
      onUnknownRoute = null,
      routes = null,
      initialRoute = null;