Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Simplify the integration of custom widgets with MultiProvider #237

Open
rrousselGit opened this issue Oct 10, 2019 · 0 comments · May be fixed by #243

Comments

@rrousselGit
Copy link
Owner

@rrousselGit rrousselGit commented Oct 10, 2019

Problem:

MultiProvider is a very important feature for a provider. But it is currently tedious and error-prone to make a widget compatible with MultiProvider:

  • we have to implement SingleChildCloneableWidget, that is very error-prone (easy to forget a parameter)
  • it usually requires an extra private constructor, just for the clone implementation

All in all, it's too complex, which makes peoples not want to make custom providers and stick to the existing ones.

Solution

I made a POC of an alternate implementation of MultiProvider, which doesn't relly on a "clone" method.

Instead, it uses a new kind of widget (neither Stateless nor Stateful): SingleChildStatelessWidget / SingleChildStatefulWidget.

The difference is that the build method takes an extra Widget child parameter:

class Example extends SingleChildStatelessWidget {
  Example({Key key, Widget child}): super(key: key, child: child);

  @override
  Widget build(BuildContext context, {Widget child}) {
    // TODO: do something with `child`
  }
}

Which is then instantly compatible with MultiProvider:

MultiProvider(
  providers: [
    Example(),
  ],
)

Consequences:

The SingleChildCloneableWidget interface will be removed, and replaced by a SingleChildWidget interface and two implementations:

  • SingleChildStatelessWidget
  • SingleChildStatefulWidget

MultiProvider will then accept a SingleChildWidget instead of SingleChildCloneableWidget

Existing implementations of SingleChildCloneableWidget should be migrated to use one of the two SingleChildWidget implementation instead.

Before:

class Example extends StatelessWidget implements SingleChildCloneableWidget {
  Example({Key key, int value, this.child}): this(key: key, foo: Foo(value), child: child);

  Example._({Key key, this.foo, this.child): super(key: key);

  final Foo foo;
  final Widget child;

  @override
  Widget build(BuildContext context) {
    return Whatever(
      foo: foo,
      child: child,
    );
  }

  @override
  Example cloneWithChild(Widget child) {
    return Example._(
      key: key,
      foo: foo,
      child: child,
    );
  }
}

After:

class Example extends SingleChildStatelessWidget {
  Example({Key key, int value, Widget child}): foo = Foo(value), super(key: key, child: child);

  final Foo foo;

  @override
  Widget build(BuildContext context, {Widget child}) {
    return Whatever(
      foo: foo,
      child: child,
    );
  }
}
@rrousselGit rrousselGit added this to the 4.0.0 milestone Oct 10, 2019
@rrousselGit rrousselGit linked a pull request that will close this issue Nov 26, 2019
@rrousselGit rrousselGit added this to To do in 4.0.0 Nov 30, 2019
@rrousselGit rrousselGit moved this from To do to Done in 4.0.0 Nov 30, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
4.0.0
  
Done
1 participant
You can’t perform that action at this time.