Flutter: go_router how to pass multiple parameters to other screen?

Edit: Breaking changes in Go_router 7.0.0

In NutShell

Below Go Router 7 i.e < 7.0.0 use `params`, `queryParams`
Above Go Router 7 i.e >=7.0.0 use `pathParameters`, `queryParameters`

Summary:

There are three ways: pathParameters, queryParameters, extra

1. Using pathParameters
   • When you know the number of parameters beforehand
   • Usage : path="/routeName/:id1/:id2"
2. Using queryParameters
   • When you are not sure about the number of parameters
   • Usage : path="/routeName"
3. Using extra
   • When you want to pass object

---

Explanation:

1. Using pathParameters

When you know number of params beforehand use pathParameters prop in context.goNamed()

Define it as:

GoRoute(
  path: '/sample/:id1/:id2',  // 👈 Defination of params in the path is important
  name: 'sample',
  builder: (context, state) => SampleWidget(
    id1: state.pathParameters['id1'],
    id2: state.pathParameters['id2'],
  ),
),

Call it as:

ElevatedButton(
  onPressed: () {
    var param1 = "param1";
    var param2 = "param2";
    context.goNamed("sample", pathParameters: {'id1': param1, 'id2': param2});
  },
  child: const Text("Hello"),
),

Receive it as:

class SampleWidget extends StatelessWidget {
  String? id1;
  String? id2;
  SampleWidget({super.key, this.id1, this.id2});

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

---

2. Using queryParameters

You have access to queryParameters in the context.goNamed() function. The best thing about queryParameters is that you don’t have to explicitly define them in your route path and can easily access them using the state.queryParameters method. You can add miscellaneous user-related data as a query parameter.

Define it as :

GoRoute(
  name: "sample",
  path: "/sample",          
  builder: (context, state) => SampleWidget(
      id1: state.queryParameters['id1'],
      id2: state.queryParameters['id2'],
  ),
)

Call it as:

ElevatedButton(
  onPressed: () {
    var param1 = "param1";
    var param2 = "param2";
    context.goNamed("sample", queryParameters: {'id1': param1, 'id2': param2});
  },
  child: const Text("Hello"),
),

Receive it as:

class SampleWidget extends StatelessWidget {
  String? id1;
  String? id2;
  SampleWidget({super.key, this.id1, this.id2});

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

---

3. Using extra

Use this when you want to pass a model/object between routes

GoRoute(
  path: '/sample',
  builder: (context, state) {
    Sample sample = state.extra as Sample; // 👈 casting is important
    return GoToScreen(object: sample);
  },
),

Refer https://stackoverflow.com/a/74813017/13431819 for passing object between routes