smf_go_router

The SMF module that routes the app with go_router 17. It provides the router role of SMF.

The features of the app declare their routes, and the router role gives the app a typed navigation facade, context.nav, with go(), push() and replace() for every route. This module turns the routes into the GoRouter of the app. With a layout, such as tabs at the bottom, it builds the main navigation of the app around it. It tells the listeners of the screen, such as analytics, about each screen the user sees. When a module keeps the user from the screens of the app with a guard until a condition holds, it shows the screen of the guard in their place. Once the guard allows, it shows what the router role answers: the screen that the user asked for, the screen that they were on, or the screen that the app starts on. A guard may also keep the user only from the screens that ask for its condition, such as an account. The module then opens the screen of the guard over the screen that the user is on when one of those is asked for. The user can go back from it, and once the condition holds, the module closes it and shows the screen that was asked for.

Use with the SMF CLI

smf create asks which module provides the router, and offers none as well. When a module you chose needs a router, such as the start screen of home, smf create adds this one by itself if it is the only module that provides the router, and asks otherwise. To choose it without the question:

smf create my_app -m go_router

When several routes can start the app, smf create asks which one, or takes it from --start, such as --start /home.

You don't add this package to an app yourself: smf create of the SMF CLI puts what the module generates into the app.

SMF generates apps for Flutter 3.44 or newer and Dart 3.12 or newer. It is tested on macOS, Linux and Windows.

Documentation

• The go_router module
• Navigation