auto_route #

AutoRoute is a declarative routing solution, where everything needed for navigation is automatically generated for you.

The official docs will be added soon. Legacy Docs #

• Installation
• Setup and Usage
• Navigation

Installation #

dependencies:
  auto_route: [latest-version]

dev_dependencies:
  auto_route_generator: [latest-version]
  build_runner:

Setup and Usage #

First create a router config class and annotate it with @MaterialAutoRouter, @CupertinoAutoRouter, @AdaptiveAutoRouter or @CustomAutoRouter. It's name must be prefixed with $ to get a generated class with the same name minus the $. $RouterConfig => RouterConfig

Note: using $ prefix is mandatory.

@MaterialAutoRouter(...config)  //CustomAutoRoute(..config)
class $MyRouterConfig {}

Declare your AutoRoutes in MaterialAutoRouter() annotation

• paths are optional, if not provided auto-generated paths will be used.

@MaterialAutoRouter(
  routes: <AutoRoute>[
    AutoRoute(path: '/': page: HomePage),
    AutoRoute(path: '/books', page: BookListPage),
    AutoRoute(path: '/books/:id', page: BookDetailsPage),
  ],
)
class $MyRouterConfig {}

Now simply run the generator

Use the [watch] flag to watch the files' system for edits and rebuild as necessary.

flutter packages pub run build_runner watch

if you want the generator to run one time and exits use

flutter packages pub run build_runner build

Finalize the setup

after you run the generator your router config class will be generated, use it as follows:

   // in your app state
   final routerConfig = MyRouterConfig()
   ...
  Widget build(BuildContext context){
      return MaterialApp.router(
             // RootRouterDelegate is from auto_route package
             routerDelegate: RootRouterDelegate(routerConfig),
             routeInformationParser: routerConfig.nativeRouteParser,
         ),
  }

Navigation #

Use AutoRouter to push PageRouteInfo objects that's generated for you

AutoRouter.of(context).push(BooksListPageRoute())
// or you can use the extension
context.router.push(BooksListPageRoute())

Support auto_route #

You can support auto_route by liking it on Pub and staring it on Github, sharing ideas on how we can enhance a certain functionality or by reporting any problems you encounter