97

While implementing persistent bottom bar, previous route need to be restored when a button in the bottom bar was clicked.

When a button in the bottom bar is clicked, its current route path (/a/b/c) is saved and previously saved route is restored according to the button click.

Conceptually user will think each button as a workspace and its state is never get lost (including back stack). User can safely switch from one workspace to another.

How to get current route path in Flutter, when the routing is rewinding to root?

Kyaw Tun
  • 12,447
  • 10
  • 56
  • 83
  • 1
    Many things were added in Navigator 2.0: https://medium.com/flutter/learning-flutters-new-navigation-and-routing-system-7c9068155ade For new apps consider a whole different design. – Alexey Inkin Mar 22 '21 at 10:19

12 Answers12

162

ModalRoute should give you the exact route name

ModalRoute.of(context).settings.name

if you use Navigator.popuntil.. check this other answer out by Rémi Rousselet https://stackoverflow.com/a/50817399/5921185

Ber
  • 40,356
  • 16
  • 72
  • 88
ikben
  • 4,246
  • 4
  • 21
  • 27
32

In case if you want to get current route by use navigator key, possible to use popUntil method for it:

String? currentPath;
navigatorKey.currentState?.popUntil((route) {
  currentPath = route.settings.name;
  return true;
}); 
StasVo
  • 554
  • 6
  • 6
30

NavigatorState doesn't expose an API for getting the path of the current route, and Route doesn't expose an API for determining a route's path either. Routes can be (and often are) anonymous. You can find out if a given Route is on the top of the navigator stack right now using the isCurrent method, but this isn't very convenient for your use case.

I would recommend that you take a different approach to this problem and don't rewind to the root at all. Instead, use a different Navigator widget for each pane of the BottomNavigationBar. That way, you won't have to rewind the stack when switching between panes. You can wrap your Navigator widgets in Opacity and IgnorePointer widgets to hide them when they aren't supposed to be visible without destroying their stack.

app video

import 'package:flutter/material.dart';

void main() {
  runApp(new MyApp());
}

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return new MaterialApp(
      home: new MyHomePage(),
    );
  }
}

class SecurePage extends StatelessWidget {
  final int index;

  SecurePage(this.index);

  Widget build(BuildContext context) {
    return new Material(
      color: Colors.amber,
      child: new InkWell(
        child: new Center(
          child: new Icon(
            Icons.security,
            color: Colors.white,
            size: index * 100.0 + 20.0,
          ),
        ),
        onTap: () {
          Navigator.of(context).push(
            new MaterialPageRoute(
              builder: (BuildContext context) {
                return new SecurePage(index + 1);
              },
            ),
          );
        },
      ),
    );
  }
}

class VerifiedPage extends StatelessWidget {
  final int index;

  VerifiedPage(this.index);

  Widget build(BuildContext context) {
    return new Material(
      color: Colors.green,
      child: new InkWell(
        child: new Center(
          child: new Icon(
            Icons.verified_user,
            color: Colors.white,
            size: index * 100.0 + 20.0,
          ),
        ),
        onTap: () {
          Navigator.of(context).push(
            new MaterialPageRoute(
              builder: (BuildContext context) {
                return new VerifiedPage(index + 1);
              },
            ),
          );
        },
      ),
    );
  }
}

class MyHomePage extends StatefulWidget {
  @override
  State createState() => new MyHomePageState();
}

class MyHomePageState extends State<MyHomePage> {
  int _page = 0;
  List<Widget> initialWidgets = <Widget>[
    new SecurePage(0),
    new VerifiedPage(0),
  ];

  Widget build(BuildContext context) {
    return new Scaffold(
      body: new Stack(
        children: new List<Widget>.generate(initialWidgets.length, (int index) {
          return new IgnorePointer(
            ignoring: index != _page,
            child: new Opacity(
              opacity: _page == index ? 1.0 : 0.0,
              child: new Navigator(
                onGenerateRoute: (RouteSettings settings) {
                  return new MaterialPageRoute(
                    builder: (_) => initialWidgets[index],
                  );
                },
              ),
            ),
          );
        }),
      ),
      bottomNavigationBar: new BottomNavigationBar(
        currentIndex: _page,
        onTap: (int index) {
          setState(() {
            _page = index;
          });
        },
        items: <BottomNavigationBarItem>[
          new BottomNavigationBarItem(
            icon: new Icon(Icons.security),
            title: new Text('Secure'),
          ),
          new BottomNavigationBarItem(
            icon: new Icon(Icons.verified_user),
            title: new Text('Verified'),
          ),
        ],
      ),
    );
  }
}
alfiepoleon
  • 1,781
  • 1
  • 16
  • 18
Collin Jackson
  • 110,240
  • 31
  • 221
  • 152
  • 1
    Wow! Beautify. This solution also solve other state problem I am having. – Kyaw Tun Sep 30 '17 at 04:26
  • In fact, I was tinkering around `Stack` and `Opacity`, but not able to get it work. I was not aware `Navigator` can be localised. `IgnorePointer` is another trick I was not able to figure out. Combining the two, a build-in [Hide-Show Widget](https://stackoverflow.com/questions/44489804/show-hide-widgets-on-flutter-programmatically) will be good, to make them discoverable. – Kyaw Tun Sep 30 '17 at 04:28
  • This fantastic solution has [other issue](https://stackoverflow.com/questions/46500186/flutter-keyboard-issue-when-wrap-under-stack-opacity-scrollable). – Kyaw Tun Sep 30 '17 at 06:28
  • @CollinJackson What happens if `IgnorePointer` isn't included? I read the documentation but am still unsure how it relates to the navigation stack – geg Oct 22 '20 at 23:33
18

If you are using go_router package you can use the below code :

GoRouter.of(context).location

Update on go_router 10.0.0 (2023) :

GoRouterState.of(context).uri.toString();
ParSa
  • 1,118
  • 1
  • 13
  • 17
  • 1
    If you don't have the context, you can also use the navigatorKey: `final currentPath = GoRouter.of(navigatorKey.currentContext!).location;` – Till Friebe Jun 08 '23 at 15:24
  • What's the difference from `uri.toString()` and `routeInformationProvider.value.location`? – Kyle Venn Aug 28 '23 at 19:39
14

Posting this answer mainly for archival purposes, but as @ikben mentioned, one way to get the current route, and all its properties, is ModalRoute.of(context). This returns a ModalRoute, which despite its name, applies to most Navigator.push calls, not just showDialog. Helpful properties include Route.settings, Route.navigator, and Route.isFirst.

Levi Lesches
  • 1,508
  • 1
  • 13
  • 23
5

If you are using the go_router package version >= 9.0.0:

GoRouter.of(context).routeInformationProvider.value.location

or

GoRouterState.of(context).location
Domenico
  • 1,331
  • 18
  • 22
3

I'm using go_router in my project. In go_router, you access current route as below

    var currentRoute = GoRouter.of(context).location;
O Vuruşkaner
  • 141
  • 1
  • 3
2

If you're using go_router:

GoRoute(
  name: 'login',
  path: '/login',
  builder: (context, state) => LoginScreen(),
),

use this

GoRouterState.of(context).path

for named routes use:

GoRouterState.of(context).name
Tom Raganowicz
  • 2,169
  • 5
  • 27
  • 41
2

I was using onGenerateRoute so I also had this issue. I resolved it by using NavigatorObserver

import 'package:flutter/material.dart';

class AppNavObserver extends NavigatorObserver {
  static final navStack = <RouteStackItem>[];

  @override
  void didPop(Route route, Route? previousRoute) {
    if (previousRoute != null) {
      navStack.removeLast();
    }
    super.didPop(route, previousRoute);
  }

  @override
  void didPush(Route route, Route? previousRoute) {
    navStack.add(RouteStackItem.fromRoute(route));
    super.didPush(route, previousRoute);
  }

  @override
  void didRemove(Route route, Route? previousRoute) {
    if (previousRoute != null) {
      navStack.removeLast();
    }
    super.didRemove(route, previousRoute);
  }

  @override
  void didReplace({Route? newRoute, Route? oldRoute}) {
    if (oldRoute != null) {
      navStack.removeLast();
    }
    if (newRoute != null) {
      navStack.add(RouteStackItem.fromRoute(newRoute));
    }
    super.didReplace(newRoute: newRoute, oldRoute: oldRoute);
  }

  @override
  void didStartUserGesture(Route route, Route? previousRoute) {
    // TODO: implement didStartUserGesture
    super.didStartUserGesture(route, previousRoute);
  }

  @override
  void didStopUserGesture() {
    // TODO: implement didStopUserGesture
    super.didStopUserGesture();
  }
}

class RouteStackItem {
  final String? name;
  final Object? args;

  const RouteStackItem({
    required this.name,
    required this.args,
  });

  factory RouteStackItem.fromRoute(Route route) =>
      RouteStackItem(name: route.settings.name, args: route.settings.arguments);
}

In main.dart

MaterialApp(
              debugShowCheckedModeBanner: false,
              title: flavorConfig.appTitle,
              color: AppColors.primary,
              theme: AppTheme.light,
              navigatorObservers: [
                AppNavObserver()
              ],.....

Then you can use this to get the current route from anywhere

   var navStack = AppNavObserver.navStack;
          var routeSettings = navStack.isEmpty ? null : navStack.last;
1

I found a much simpler solution. I love StatelessWidget's so I did it with a static, but you can do it with a StatefulWidget. You'll need a StatefulWidget if you have hierarchical navigation. This is a tile in my NavDrawer. (Statics get a bad rap but in a UI it's not bad, there's only one process running a single thread.)

class NavListTile extends StatelessWidget {
  static String currentRoute = 'dashboard';
  final String route;

  const NavListTile({
    Key? key,
    required this.route,
  }) : super(key: key);

  @override
  Widget build(BuildContext context) {
    var isCurrent = currentRoute == route;
    String suffix = isCurrent ? '_green' : '';
    return ListTile(
      title: NavMenuItem(capitalizedRoute, isCurrent,
          "assets/images/" + route + suffix + ".png", context),
      onTap: () {
        currentRoute = route;
        Navigator.of(context).pushNamed('/' + route);
      },
    );
  }
}
Michael Bushe
  • 1,503
  • 16
  • 16
1

You could write a convenient extension on NavigatorState to get the first route in the stack:

extension NavigatorStateX on NavigatorState {

  String? get currentRouteName {
    String? name;
    popUntil((route) {
      name = route.settings.name;
      return true;
    });
    return name;
  }

}
0

I didn't have context available but was able to import the router from the file it was defined in and use like this:

router.routeInformationProvider.value.location
starball
  • 20,030
  • 7
  • 43
  • 238
user3413723
  • 11,147
  • 6
  • 55
  • 64