[go_router] Figure out how to deal with inline GoRouter creation in MaterialApp.router

Is there an existing issue for this?

I have searched the existing issues
I have read the guide to filing a bug

Use case

It is possible to create GoRouter inline with MaterialApp

void main() {
  runApp(MaterialApp.router(routerConfig: GoRouter()));
}

This will break hot reload because the gorouter will be recreate and loss all its state.

Another example is

class MyWidget extends StatelessWidget {
  @override
  Widget build(context) {
    return MaterialApp.router(routerConfig: GoRouter());
  }
}

Which would lose the state every time MyWidget is rebuilt.

Proposal

We should figure out how to avoid this situation. One idea can be writing a lint to warn user and advise putting the goRouter into a permanent variable

@chunhtai

@chunhtai I got bitten by this also. I think having a linter rule for this would be a great step forward. 👍

A question.

I have personally not had to experience this; I came across this while reading Andrea's article.
So my question is, What if it was a final variable in a class?

class AppRouter {
  final router = GoRouter();
}

And then:

class MyWidget extends StatelessWidget {
  @override
  Widget build(context) {
// This could also be a state variable if MyWidget was a stateful widget
final appRouter = AppRouter();
    return MaterialApp.router(routerConfig: appRouter.router);
  }
}

@davidnwaneri

@davidnwaneri
Unless it is a static variable, it would still be recreated when the build method is called.

test: guard inline config() through a hot reload (flutter/flutter#127206

Navigation Menu

Repository navigation

[go_router] Figure out how to deal with inline GoRouter creation in MaterialApp.router #127206

Is there an existing issue for this?

Use case

Proposal

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

[go_router] Figure out how to deal with inline GoRouter creation in MaterialApp.router #127206

Description

Is there an existing issue for this?

Use case

Proposal

Activity

bizz84 commented on Jun 18, 2023

davidnwaneri commented on Aug 29, 2023

chunhtai commented on Aug 29, 2023

Metadata

Metadata

Assignees

Labels

Type

Projects

Milestone

Relationships

Development

Issue actions