springBootStarterFlutterNavigationAutoConfiguration top-level property

  1. @AutoConfigurationModule()
BeanModule springBootStarterFlutterNavigationAutoConfiguration
final

The beans the starter adds to every Flutter application with screens (a ScreenRoutes bean; the annotated screens make one):

  • the route and branch scopes (NavigationScopesRegistrar);
  • the navigation: every ScreenRoutes bean (the annotated screens are one) put together and checked at the start, the RouteFilter beans, the redirects and first address of spring.flutter.navigation.*;
  • the RouteTemplate (routeTemplate);
  • the router SpringApp builds the app widget on (springRouterConfig, a RouterConfig<Object>), with addresses without # in a browser (spring.flutter.navigation.web.url-strategy).

Implementation

@AutoConfigurationModule()
final BeanModule springBootStarterFlutterNavigationAutoConfiguration =
    BeanModule(
      'springBootStarterFlutterNavigationAutoConfiguration',
      [
        BeanDefinition<NavigationScopesRegistrar>(
          name: 'navigationScopesRegistrar',
          types: const [NavigationScopesRegistrar, BeanFactoryPostProcessor],
          source: _source,
          create: (_) => const NavigationScopesRegistrar(),
        ),
        BeanDefinition<Navigation>(
          name: 'navigation',
          conditions: const [
            ConditionGroup('$_source.navigation', [
              ConditionalOnBean(ScreenRoutes),
            ]),
          ],
          source: _source,
          create: (r) {
            final properties = r.dependency<NavigationProperties>();
            return Navigation(
              table: RouteTable(
                r.optionalDependencyList<ScreenRoutes>() ?? const [],
                redirects: properties.redirects ?? const {},
              ),
              conversion:
                  r.optionalDependency<ConversionService>(
                    qualifier: 'conversionService',
                  ) ??
                  r.conversionService,
              scopes: r.dependency<RouteScopes>(),
              filters: r.optionalDependencyList<RouteFilter>() ?? const [],
              messages: r.dependency<ApplicationContext>(),
              initial: properties.initial,
              linkExclude: properties.deepLinks.exclude ?? const [],
              languages: properties.languages ?? const [],
              events: r.dependency<ApplicationEventPublisher>(),
            );
          },
          preDestroy: (navigation) {
            navigation.scopes.destroyAll();
            navigation.dispose();
          },
        ),
        BeanDefinition<RouteLanguageCustomizer>(
          name: 'routeLanguageCustomizer',
          types: const [RouteLanguageCustomizer, FlutterAppCustomizer],
          conditions: const [
            ConditionGroup('$_source.routeLanguageCustomizer', [
              ConditionalOnBean(ScreenRoutes),
            ]),
          ],
          source: _source,
          create: (r) => RouteLanguageCustomizer(r.dependency<Navigation>()),
        ),
        BeanDefinition<RouteTemplate>(
          name: 'routeTemplate',
          conditions: const [
            ConditionGroup('$_source.routeTemplate', [
              ConditionalOnBean(ScreenRoutes),
            ]),
          ],
          source: _source,
          create: (r) => RouteTemplate(r.dependency<Navigation>()),
        ),
        BeanDefinition<ScreenMappings>(
          name: 'screenMappings',
          types: const [ScreenMappings, MappingDescriptions],
          conditions: const [
            ConditionGroup('$_source.screenMappings', [
              ConditionalOnBean(ScreenRoutes),
            ]),
          ],
          source: _source,
          create: (r) => ScreenMappings(r.dependency<Navigation>()),
        ),
        // Lazy: made when SpringApp asks for it, where Flutter's binding
        // exists (a context without widgets, a server test, never makes
        // it), still before the router reads the first address.
        BeanDefinition<SpringRouterConfig>(
          name: 'springRouterConfig',
          lazy: true,
          conditions: const [
            ConditionGroup('$_source.springRouterConfig', [
              ConditionalOnBean(ScreenRoutes),
            ]),
          ],
          types: const [
            SpringRouterConfig,
            RouterConfig<RouteLocation>,
            RouterConfig<Object>,
          ],
          source: _source,
          create: (r) {
            final properties = r.dependency<NavigationProperties>();
            if (kIsWeb &&
                properties.web.urlStrategy == NavigationUrlStrategy.path) {
              _pathUrls();
            }
            return SpringRouterConfig(r.dependency<Navigation>());
          },
        ),
      ],
      imports: [navigationConfigBeans],
    );