This example works with no side effects, no ChangeNotifier, no weird ref piping; we just write handle our router declaratively, with a few LOC. Reactive dependencies are directly written in the Router's Provider, while no unnecessary rebuilds are being performed.

The main trick

All of our legacy exmples included workarounds to avoid unnecessary rebuilds at the top of our Widget Tree (where the router lies). The simple trick here is to use a GlobalKey on top of our router: this tells the Framework not to rebuild the whole widget tree.

At the same time, our router is rebuilt, with no side effects or special caring about refs usage. This enables the developer to just write - declaratively - all the dependencies needed directly in the Provider, i.e. to use Riverpod how it is supposed to be used.

Is this approach advised?

Absolutely; at this very moment I can't find any downsides to this approach. But if you find any, you're welcome to open issues or PR.

Always consider that the examples in this repo are tested (use flutter test for a quick check).

Wait a minute, I do see unnecessary rebuilds

Are you absolutely sure? Before we raise red flags onto this example, consider that this routerProvider does trigger rebuilds on MyAwesomeApp, but because of the GlobalKey<NavigatorState>() we've set onto our router, Flutter won't trigger a rebuild on the whole Widget tree.

Please read this discussion for a detailed explanation.

If you're still convinced this approach doesn't work out, and you want to share your thoughts, you're very welcome to open an issue or a PR.

Getting started

First, read the code:

'lib/main.dart' has UI elements
'lib/router.dart' has the routing logic
'lib/auth.dart' has the auth logic

Most of the actions are mocked, here. Then, run:

flutter test flutter run

Enjoy!