Manage Global State

Modules are code that can be accessed app wide. These are registered using a locator.

How to Register a Module

To register a module, you add it to the modules list in the locator_config.dart file. The builder function is called when the module is first accessed, and the lazy property determines if the module is created when the app starts, or when it is first accessed.

1
Module<ModuleName>(
2
  builder: () => ModuleName(),
3
  lazy: false,
4
);

Default Modules

There are 4 default modules that are registered when the app starts:

• RouterService - The router service is used to navigate between routes.
• NotifyService - The notify service is used to show toasts and haptic feedback.
• HttpAbstraction - The http abstraction is used to make http requests.

1
final modules = [
2
  Module<RouterService>(
3
    builder: () => RouterService(supportedRoutes: routes),
4
    lazy: false,
5
  ),
6
  Module<ToastService>(
7
    builder: () => ToastService(),
8
    lazy: true,
9
  ),
10
  Module<HttpAbstraction>(
11
    builder:
12
        () => HttpAbstraction(
13
          interceptors: [
14
            LoggingInterceptor(
15
              logBody: !kReleaseMode, // Only log bodies in debug mode
16
            ),
17
          ],
18
        ),
19
    lazy: true,
20
  ),
21
];

How to Use a Module

To use a module, you can use the locator to get the module.

1
locator<ModuleName>();