riverpod icon indicating copy to clipboard operation
riverpod copied to clipboard

[riverpod.dev] Getting started could provide more info on hooks and/or flutter_hooks

Open clocksmith opened this issue 1 year ago • 0 comments

Describe what scenario you think is uncovered by the existing examples/articles

Browsed through riverpod.dev for first time, and had some difficulty deciding on which package to use for a Flutter app at https://riverpod.dev/docs/getting_started. It only took a min to understand when to use flutter_riverpod vs riverpod, but much longer for hooks_riverpod vs flutter_riverpod. There is a table, but the descriptions do not provide enough context to make a decision.

The ordering of the table implies to maybe start with only flutter_riverpod, and the following section: "Installing the package" has a different order, and suggests that hooks should be used when getting started.

Describe why existing examples/articles do not cover this case

Hooks are eventually expanded upon in https://riverpod.dev/docs/concepts/reading , but it would still might be helpful to get an intro to hooks in the getting started guide. A few sentences can probably be borrowed from theflutter hooks pub package, and riverpod should probably also make a stronger opinion on what the best practice is for use cases.

Screen Shot 2022-09-03 at 12 18 10 AM Screen Shot 2022-09-03 at 12 18 19 AM

Possible fix

Add a footnote to the hooks description in table beyond: A way to use both [flutter_hooks](https://github.com/rrousselGit/flutter_hooks) and [Riverpod](https://github.com/rrousselgit/riverpod) together. explaining what hooks are and who might want to use them.

clocksmith avatar Sep 02 '22 22:09 clocksmith