Observer for Navigator route changes in Flutter

user_3217522 0
Viewed 15037

Is there a way to listen to route changes of the Navigator in Flutter? Basically, I'd like to be notified when a route is pushed or popped, and have the current route on display on screen be returned from the notification

dart flutter
3 Answers
user_7866560

I was also struggling with that and for my purpose the RouteObservers felt overkill and where too much for my needs. The way I handled it lately was to use the onGenerateRoute property inside my MaterialApp. So this solution is more applicable if you are using onGenerateRoute with your app (might especially be useful if you are navigating with arguments). You can read more about it here.

My MaterialApp looks like the following:

runApp(MaterialApp(
        title: 'bla',
        home: BuilderPage(LoginArguments(false)),
        onGenerateRoute: generateRoute
));

The generateRoute method looks like the following:

Route<dynamic> generateRoute(RouteSettings settings) {
  switch (settings.name) {
    case 'main':
      print('Navigated to main')
      return MaterialPageRoute(builder: (_) => MainScreen());
    case 'register':
      print('Navigated to register')
      return MaterialPageRoute(builder: (_) => RegisterScreen());
    default:
      return MaterialPageRoute(
          builder: (_) => Scaffold(
                body: Center(
                    child: Text('No route defined for ${settings.name}')),
              ));
  }
}

So everytime I now do for example:

Navigator.pushNamed(
        context,
        'register',
      );

It will print Navigated to register. I think this way is especially helpful if you don't necessarily need to know whether you pushed or popped. With some additional implementation it would also be possible to observe that via injected arguments.

user_44401330
Related