How to get current route path in Flutter?

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;
}); 

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.

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'),
          ),
        ],
      ),
    );
  }
}

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();

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.

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

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

or

GoRouterState.of(context).location

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;

If you are using go_router ^11, use

router.routeInformationProvider.value.uri

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

    var currentRoute = GoRouter.of(context).location;

This works for me

final routeName = Navigator.of(context).widget.pages.last.name;

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

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

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);
      },
    );
  }
}

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;
  }

}

For go_router: >13.0.1

with context:

final currentPath = 
GoRouter.of(context).routeInformationProvider.value.uri.path

with Global / Navigator Key:

final currentPath =  GoRouter.of(goRouterKey.currentContext!).routeInformationProvider.value.uri.path

inside GoRouter redirect:

GoRouter(redirect: (context, state) {final currentPath =  state.uri.path}

ModalRoute.of(context).settings.name should be one of the easy ways to get the route name, as mentioned in previous answers.

But, it was giving me null for some routes. To solve this, I had to do the following.

I am using onGenerateRoute to register AppRoutes in MyApp.

My AppRoutes class was something like this:

class AppRoutes {
  static Route onGenerateRoutes(RouteSettings routeSettings) {
    switch (routeSettings.name) {
      case "/":
        return _materialPageRoute(const News());
      case "/saved_articles":
        return _materialPageRoute(const SavedArticles());
      default:
        return _materialPageRoute(const News());
    }
  }

  static Route _materialPageRoute(Widget page) {
    return MaterialPageRoute(builder: (context) => page);  // RouteSettings was not included
  }
}

Then, I made changes to include RouteSettings to MaterialPageRoute. This solves the problem of null value for route names.

class AppRoutes {
  static Route onGenerateRoutes(RouteSettings routeSettings) {
    switch (routeSettings.name) {
      case "/":
        return _materialPageRoute(const News(), routeSettings);
      case "/saved_articles":
        return _materialPageRoute(const SavedArticles(), routeSettings);
      default:
        return _materialPageRoute(const News(), routeSettings);
    }
  }

  static Route _materialPageRoute(Widget page, RouteSettings routeSettings) {
    return MaterialPageRoute(
        settings: routeSettings, builder: (context) => page); // RouteSettings is now included
  }
}

I was only able to reliably get the current route at any state of my app using this strategy:

1. use global navigator key in the main app

final GlobalKey<NavigatorState> navigatorKey = GlobalKey<NavigatorState>();
...
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
      navigatorKey: navigatorKey,
...

2. in any place of the app, get the current route like this

String? getCurrentRoute(){
  String? currentRoute = null;
  navigatorKey.currentState?.popUntil((route) {
    currentRoute = route.settings.name;
    return true;
  });
  return currentRoute;
}
final route = getCurrentRoute();