auto_route 0.3.0 copy "auto_route: ^0.3.0" to clipboard
auto_route: ^0.3.0 copied to clipboard

Published 4 years ago • verified publishercodeness.lyDart 3 incompatible• Latest: 9.2.2
outdated
→

Metadata

AutoRoute is a route generation library, where everything needed for navigation is automatically generated for you.

More...

auto_route: #

AutoRoute is a route generation library, where everything needed for navigation is automatically generated for you.

Installation #

dependencies:
  # add auto_route to your dependencies
  auto_route: [latest-version]

dev_dependencies:
  # add the generator to your dev_dependencies
  auto_route_generator: [latest-version]
  # of course build_runner is needed to run the generator
  build_runner:

Setup and Usage #

First create a router config class then annotate it with @MaterialAutoRouter, @CupertinoAutoRoute or @CustomAutoRoute. It's name must be prefixed with $ to get a generated class with the same name minus the $.
$Router => Router

Note: using $ prefix is mandatory.
@MaterialAutoRouter(...config)  //CustomAutoRoute(..config)
class $Router {

}

Now start adding your routes as class fields with the desired route names:

Only use the @MaterialRoute() or @CupertinoRoute() annotations to customize your route

@MaterialAutoRouter()
class $Router {
 // use @initial or @CupertinoRoute(initial: true) to annotate your initial route.
  @initial
  HomeScreen homeScreenRoute; // your desired route name

  SecondScreen secondScreenRoute;

  //optional route Customization
  @CupertinoRoute(fullscreenDialog: true)
  LoginScreen loginScreenRoute;
}

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 class will be generated containing all of your route names and the onGenerateRoute function implementation.

class MyApp extends StatelessWidget {
  @override
  Widget build(BuildContext context) {
    return MaterialApp(
    // hook up the onGenerateRoute function in the generated Router class
    // with your Material app
      onGenerateRoute: MyRouter.onGenerateRoute,
      navigatorKey: MyRouter.navigator.key,
      initialRoute: MyRouter.homeScreenRoute,
    );
  }
}

Inside of the Generated class

class Router{
   // your route names will be generated as static const Strings
  static const loginScreenRoute = '/login-screen-route';

      static Route<dynamic> onGenerateRoute(RouteSettings settings) {
        switch (settings.name) {
        // The generated code for LoginScreen is
          case Router.loginScreenRoute:
            return CupertinoPageRoute<dynamic>(
              builder: (_) => LoginScreen(),
              settings: settings,
              fullscreenDialog: true
            );

          default:
          // autoRoute handles unknown routes for you
            return unknownRoutePage(settings.name);
        }
 } }

Customization #

@MaterialAutoRouter | @CupertinoAutoRouter
Property Default value Definition
generateRouteList [bool] false if true a list of all routes will be generated

@CustomAutoRouter

Property Default value Definition
transitionsBuilder [Function] null extension for the transitionsBuilder property in PageRouteBuilder
opaque [bool] true extension for the opaque property in PageRouteBuilder
barrierDismissible [bool] false extension for the barrierDismissible property in PageRouteBuilder
durationInMilliseconds [double] null extension for the transitionDuration(millieSeconds) property in PageRouteBuilder

@MaterialRoute | @CupertinoRoute | @CustomRoute

Property Default value Definition
initial [bool] false mark the route as initial '\'
name [String] null this will be assigned to the route variable name if provided (String homeScreen = [name]);
fullscreenDialog [bool] false extension for the fullscreenDialog property in PageRoute
maintainState [bool] true extension for the maintainState property in PageRoute

@CupertinoRoute Specific => CupertinoPageRoute

Property Default value Definition
title [String] null extension for the title property in CupertinoPageRoute

@CustomRoute Specific => PageRouteBuilder

Property Default value Definition
transitionsBuilder [Function] null extension for the transitionsBuilder property in PageRouteBuilder
opaque [bool] true extension for the opaque property in PageRouteBuilder
barrierDismissible [bool] false extension for the barrierDismissible property in PageRouteBuilder
durationInMilliseconds [double] null extension for the transitionDuration(millieSeconds) property in PageRouteBuilder

Passing Arguments to Routes #

That's the fun part!

You don't actually need to do anything extra. AutoRoute automatically detects your route parameters and handles them for you, and because Types are important it will make sure you pass the right argument Type

class ProductDetails extends StatelessWidget {
  final int productId;
// your route parameters are handled based on
// your widget route constructor
  const ProductDetails(this.productId);
  @override
  Widget build(BuildContext context)...
}

Generated code for the above example

 final args = settings.arguments;
  case Router.productDetailsRoute:
   // ProductDetails screen is expecting a productId of type <int>
   // so we check the passed arguments against it
    if (hasInvalidArgs<int>(args))
    // if the passed in args are mistyped, an error route page will be displayed instead
    return misTypedArgsRoute<int>(args);
    // otherwise we navigate to the desired screen
    final typedArgs = args as int;
    return MaterialPageRoute(
      builder: (_) => ProductDetails(typedArgs),
      settings: settings,
    );

Passing multiple arguments (Don't worry, We're not using a dynamic Map!)

Since you can only pass one argument to the Navigator, if you define more then one parameter in your screen constructor autoRoute will automatically generate a class that holds your screen arguments and keep them typed.

class WelcomeScreen extends StatelessWidget {
  final String title;
  final String message;
  const WelcomeScreen({this.title = "Default Title",@required this.message});

  @override
  Widget build(BuildContext context)...
}

Generated code for the above example

  • Default values are respected.
  • Required fields are also respected and handled properly.
//WelcomeScreen arguments holder class is generated
class WelcomeScreenArguments {
  final String title;
  final String message;
  // you're not going to lose your default values;
  WelcomeScreenArguments({this.title = "Default Title",@required this.message});
}

 case Router.welcomeScreenRoute:
      // if your class holder contains at least one required field the whole argument class is considered required and can not be null
        if (hasInvalidArgs<WelcomeScreenArguments>(args,isRequired: true))
          return misTypedArgsRoute<WelcomeScreenArguments>(args);
        final typedArgs =
            args as WelcomeScreenArguments ?? WelcomeScreenArguments();
        return MaterialPageRoute<dynamic>(
          builder: (_) =>
              WelcomeScreen(title: typedArgs.title, message: typedArgs.message),
          settings: settings,
        );
Pass your typed args using the generated arguments holder class
Navigator.of(ctx).pushNamed(Router.welcomeScreenRoute,
    arguments: WelcomeScreenArguments(
        title: "Hello World!"
        message: "Let's AutoRoute!"
        )
    );

Simply assign MyRouter.navigatorKey to the MaterialApp property "navigatorKey" as follows

  MaterialApp(
      onGenerateRoute: MyRouter.onGenerateRoute,
      // hook up the navigatorKey
      navigatorKey: MyRouter.navigator.key,
    );
}

Now use the navigator inside of MyRouter any where in your app.

MyRouter.navigator.pushNamed(MyRouter.secondScreen);

Nested Navigators #

Create your nested router class and define your routes as before.

@MaterialAutoRouter()
class $MyNestedRouter {
  @initial
  NestedHomePage nestedHomePage;
  NestedSecondPage nestedSecondPage;
}
Hook up your nested navigator with the Generated Router class
 Navigator(
          key: MyNestedRouter.navigator.key,
          onGenerateRoute: MyNestedRouter.onGenerateRoute),

And That's that! Now use your nested router's navigator to navigate within your nested navigator as follows

MyNestedRouter.navigator.pushNamed("your Nested route")

Route guards #

Implementing route guards requires a little bit of setup:

  1. Create your route guard by extending RouteGuard from the autoRoute package
class AuthGuard extends RouteGuard {
 @override
 Future<bool> canNavigate(
     BuildContext context, String routeName, Object arguments) async {

   SharedPreferences prefs = await SharedPreferences.getInstance();
   return prefs.getString('token_key') != null;
 }
}
  1. Register your guards
// you need to register the guards before they're needed
// main function is a good place to register your guards
 void main() {
     Router.navigator.addGuards([
       AuthGuard(),
     ]);
     runApp(MyApp());
}
  1. Annotated the routes you want to guard with @GuardedBy([..guards]) and pass in your guards as types.
 @GuardedBy([AuthGuard])
 ProfileScreen profileScreen;

Handling Wrapped Routes #

To wrap your route with a parent widget like a Provider or such, simply implement AutoRouteWrapper, and let wrappedRoute accessor return (this) as the child of your wrapper widget.

class ProductsScreen extends StatelessWidget implements AutoRouteWrapper {
  @override
  Widget get wrappedRoute => Provider(create: (ctx) => ProductsBloc(), child: this);
  ...
  }

Custom Route Transitions #

To use custom Transitions use the @CustomRoute() annotation and pass in your preferences.
The TransitionsBuilder function needs to be passed as a static/const reference that has the same signature as the TransitionsBuilder Function of the PageRouteBuilder class.
The included TransitionsBuilders Class contains a preset of common Transitions builders

@CustomRoute(transitionsBuilder: TransitionBuilders.slideBottom,durationInMilliseconds: 400)
LoginScreen loginScreenRoute;

Use @CustomAutoRouter() to define global custom route Transitions.

You can of course use your own transitionsBuilder function as long as it has the same function signature.
The function has to take in exactly a BuildContext, Animation[Double], Animation[Double] and a child Widget and it needs to return a Widget, typically you would wrap your child with one of flutter's transition Widgets as follows.

Widget zoomInTransition(BuildContext context, Animation<double> animation, Animation<double> secondaryAnimation, Widget child) {
 // you get an animation object and a widget
 // make your own transition
    return ScaleTransition(scale: animation, child: child);
  }

Now pass the reference of your function to @CustomRoute() annotation.

@CustomRoute(transitionsBuilder: zoomInTransition)
ZoomInScreen zoomInScreenRoute {}

Resources #

Acknowledgements #

Thanks to Peter Leibiger for his valuable advice.

Problems with the generation? #

Make sure you always Save your files before running the generator, if that doesn't work you can always try to clean and rebuild.

flutter packages pub run build_runner clean

← Metadata

3051
likes
0
pub points
99%
popularity

Publisher

verified publishercodeness.ly

Metadata

AutoRoute is a route generation library, where everything needed for navigation is automatically generated for you.

Repository (GitHub)
View/report issues

License

unknown (license)

Dependencies

flutter

More

Packages that depend on auto_route

Back