How to pass an Argument as SerializedMessage

Question

I'm quite new to Flutter and to learn "best practice" I loaded up the new skeleton example app.

You get three example items in a list view and when you click on one of them you go to a details view. I want to pass the object so that for every example item there is a custom details view. So I changed the code to the following:

ListTile(
        leading: const FlutterLogo(),
        title: Text(myObject.name),
        onTap: () {
          Navigator.restorablePushNamed(
              context, ObjectDetailView.routeName,
              arguments: myObject);
        },
        trailing: const Icon(Icons.arrow_forward_ios_rounded),

But it shows the error: The arguments object must be serializable via the StandardMessageCodec.

How can I do it? This seems quite complicated for an "example app". Does it make sense to use restorablePushNamed() on a details page? Or should I switch to the "normal" push/pop-Method.

Answer 1

It does makes sense to use restorablePushNamed() or any other restorable push method if you want to preserve the current page and the state of the app when it's killed by the operating system while running in the background (on low memory condition, for example).

It's up to you decide if this is necessary in your app, otherwise, you can just use "normal" push methods without needing to serialize the arguments.

But to use State Restoration, you'll have to convert myObject to a Map or List in order to StandardMessageCodec serialize it, as @Apealed said in the comments.

To convert it to a map. you can do something like this in your class:

Map<String, dynamic> toMap() {
  return {
    "name": this.name,
    "property2": this.property2,
    ...
  };
}

You can check more info about it on documentation: flutter.dev/go/state-restoration-design