Migration Guide

What changed when upgrading to the latest go_router_modular, and how to update your code. The three things to touch are binds, transitions, and (if you use them) events.

Binds: from List<Bind> to Injector

binds used to return a List<Bind>. It now returns void (or FutureOr<void>) and you register dependencies by calling methods on the Injector it receives.

@override
List<Bind> binds() => [
      Bind.singleton((i) => AuthService()),
      Bind.lazySingleton((i) => UserRepository()),
      Bind.factory((i) => LoginController()),
    ];

@override
FutureOr<void> binds(Injector i) {
  i
    ..addSingleton<AuthService>((i) => AuthService())
    ..addLazySingleton<UserRepository>((i) => UserRepository())
    ..addFactory<LoginController>((i) => LoginController());
}

The mapping is direct:

Transitions: from PageTransition to go_transitions

The custom PageTransition enum was replaced by the go_transitions package, which is re-exported by go_router_modular. Replace PageTransition.x with GoTransitions.x.

ChildRoute(
  '/details',
  child: (context, state) => const DetailsPage(),
  transition: PageTransition.fade,
);

ChildRoute(
  '/details',
  child: (context, state) => const DetailsPage(),
  transition: GoTransitions.fade,
);

Set a default for the whole app in Modular.configure:

await Modular.configure(
  appModule: AppModule(),
  initialRoute: '/',
  defaultTransition: GoTransitions.fade,
  defaultTransitionDuration: const Duration(milliseconds: 300),
);

Dependency lookup

Reading a dependency is unchanged: use context.read<T>() inside widgets and Modular.get<T>() elsewhere.

final auth = context.read<AuthService>();
final repo = Modular.get<UserRepository>();

Events

The old event-composition mechanism — eventImports(), ModularEventListener, and the EventListenerMixin — was removed. To reuse another event module’s listeners, call its listen() synchronously from inside your own listen():

class AppEventModule extends EventModule {
  @override
  void listen() {
    AuthEventModule().listen();
    // ...your own listeners
  }
}

See the Event Module page for the full event API.

Next steps

• Dependency Injection — the full bind API.
• Routes & Modules — transitions per route.
• Event Module — composing listeners.