README.md

Welcome to Flutter Web Navigation 2.0 👋

The github repository consist of a working example of flutter web routing with private and protected routes along with params.

Navigator2.0

Navigator 2.0 uses a declarative style. Understanding Navigator 2.0 involves understanding a few of its concepts such as:

Router:

A class that manages opening and closing pages of an application. The Router widget gets the configuration from the RouteInformationParser and sends it to the RouterDelegate by calling its setNewRoutePath method and asks to the RouterDelegate to build a new Navigator widget according to the current app state. .

(new) MaterialApp MaterialApp.router({
  Key? key,
  GlobalKey<ScaffoldMessengerState>? scaffoldMessengerKey,
  RouteInformationProvider? routeInformationProvider,
  required RouteInformationParser<Object> routeInformationParser,
  required RouterDelegate<Object> routerDelegate,
  BackButtonDispatcher? backButtonDispatcher,
  Widget Function(BuildContext, Widget?)? builder,
})

RouteInformationParser:

An abstract class used by the Router's widget to parse route information into a configuration. parseRouteInformation will convert the given route information into parsed data to pass to RouterDelegate.

RouteInformation holds location and state information of a route. The location field is a String and it is equivalent to a Web URL. RouteInformationParser delegate parses the location field of the RouteInformation and returns an instance of a custom-defined data type. The instance of this data type is called a configuration in the design documents because it interprets the current app state.

@override
 parseRouteInformation()

RouteInformationProvider:

An abstract class that provides route information for the Router's widget.

RouteInformationProvider receives the route name String (URL) from the OS. RouteInformationProvider generates RouteInformation instance from the route name and notifies the Router widget. The Router widget gets the RouteInformation and passes it to the RouteInformationParser delegate by calling its parseRouteInformation method.

RouterDelegate:

An abstract class used by the Router's widget to build and configure a navigating widget.

The role of the RouterDelegate is providing the currentConfiguration to Router widget. Then the Router widget restores the RouteInformation with the help of its RouteInformationParser delegate.

BackButtonDispatcher:

Reports to a Router when the user taps the back button on platforms that support back buttons (such as Android).

class BackButtonListener extends StatefulWidget {
  final Widget child;
  final Future<bool> Function() onBackPressed;

  const BackButtonListener({
    this.child,
    this.onBackPressed,
  });
  @override
  BackButtonListenerState createState()=>BackButtonListenerState();
}

class BackButtonListenerState extends State<BackButtonListener> {

  BackButtonDispatcher dispatcher;
  @override
  void didChangeDependencies() {
    super.didChangeDependencies();
    if (dispatcher != null) {
      dispatcher.removeCallback(widget.onBackPressed);
    }
    dispatcher = Router.of(context)
        .backButtonDispatcher
        .createChildBackButtonDispatcher();
    dispatcher.addCallback(widget.onBackPressed);
    dispatcher.takePriority();
  }

  @override
  Widget build(BuildContext context) {
    return widget.child;
  }
}

TransitionDelegate:

The delegate that decides how pages transition in or out of the screen when it's added or removed. However in most use cases, DefaultTransitionDelegate does a good job with transitions. If you need to handle transitions between pages in customised way, you can create your own delegate by extending TransitionDelegate.

Demo link

If you wanna try the app, here you go:

https://finaldemo-89e12.web.app

Please share feedback and if any enhancements are required.

Auth- Private and Protected Routes

Routes with custom params

Routes with custom transition

Author

👤 Pushkar Kumar

• Twitter: @95Pushkar
• Github: @Pushkar952
• LinkedIn: @https://www.linkedin.com/in/Pushkar-Kumar/

👤 Ruchika Gupta

• Twitter: @ruchikaSjv
• Github: @geekruchika
• LinkedIn: @https://www.linkedin.com/in/ruchika-gupta/

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Pushkar Kumar.
This project is Apache License, Version 2.0 (the "License") licensed.

---

This README was generated with ❤️ by readme-md-generator