Update README.md - #1
Open
jimbeveridge wants to merge 1 commit into
Open
jimbeveridge wants to merge 1 commit into
jimbeveridge wants to merge 1 commit into
Conversation
sethladd
reviewed
Oct 3, 2016
| # flutter_flux | ||
|
|
||
| > A Dart app architecture library with uni-directional data flow inspired by [RefluxJS](https://github.com/reflux/refluxjs) and Facebook's [Flux](https://facebook.github.io/flux/). | ||
| A Dart/[Flutter](https://flutter.io) app architecture library with uni-directional data flow inspired by [RefluxJS](https://github.com/reflux/refluxjs) and Facebook's [Flux](https://facebook.github.io/flux/). [Flux](https://facebook.github.io/flux/) is the complementary “model” framework also designed by Facebook. Flutter_flux is a reimplementation of Flux that uses idiomatic Dart and integrates cleanly with Flutter. |
There was a problem hiding this comment.
If you break the lines, it makes review much easier.
| # flutter_flux | ||
|
|
||
| > A Dart app architecture library with uni-directional data flow inspired by [RefluxJS](https://github.com/reflux/refluxjs) and Facebook's [Flux](https://facebook.github.io/flux/). | ||
| A Dart/[Flutter](https://flutter.io) app architecture library with uni-directional data flow inspired by [RefluxJS](https://github.com/reflux/refluxjs) and Facebook's [Flux](https://facebook.github.io/flux/). [Flux](https://facebook.github.io/flux/) is the complementary “model” framework also designed by Facebook. Flutter_flux is a reimplementation of Flux that uses idiomatic Dart and integrates cleanly with Flutter. |
There was a problem hiding this comment.
I'd say "A library for Flutter that implements the Flux app architecture pattern, and helps enable a uni-directional data flow...."
Drop the "Dart" part.
| ## Motivation | ||
|
|
||
|  | ||
| The easiest ways to model state in Flutter are StatefulWidgets and global variables. StatefulWidgets are problematic because the data is destroyed whenever the widget hierarchy is destroyed. Therefore, state is lost when the route changes, and stateful widgets cannot be used for multiple views onto the same data. |
There was a problem hiding this comment.
I found it odd that you didn't mention State here.
|
|
||
| `flutter_flux` implements a uni-directional data flow pattern comprised of `Actions`, `Stores`, and `StoreWatchers`. | ||
| It is based on [w_flux](https://github.com/Workiva/w_flux), but modified to use Flutter instead of React. | ||
| Global variables also have issues: |
There was a problem hiding this comment.
They also make testing really difficult. (hard to dependency inject)
| ## Design | ||
|
|
||
| --- | ||
| The Flux framework is designed to solve the problems above. The dataflow in flutter_flux looks like this. |
There was a problem hiding this comment.
Isn't Flux an architectural pattern? Would it be accurate to say "Flux framework" here?
I might also use "flutter_flux library" (instead of framework)
| ```dart | ||
| // verbose syntax | ||
| actions.incrementCounter.listen(_handleAction); | ||
| After the `Store` updates, the view (widgets) need to update to match the new model. A widget registers to listen to stores in its `initStores()` function. For example: |
| } | ||
| ``` | ||
|
|
||
| Once you’ve made this call, then flutter_flux will automatically call `setState()` to force the tree to rebuild. Alternatively, you can pass a lambda function to `listenToStore()` if you want to define another behavior when a store announces a change. The important point is that, by default, you do not need to define an event listener or call `setState()`. |
There was a problem hiding this comment.
Who or what is making this call? "Once you've made this call" is hard to understand.
| ## **FAQs** | ||
|
|
||
| ## Examples | ||
| 1. **Where do I put View state, such as scroll positions?** |
There was a problem hiding this comment.
why capitalize View here? Is it a formal concept or class?
| includes instructions for building / running them. | ||
| The decision is based on whether the view state information needs to outlive the widget hierarchy, which is torn down whenever your route is changed, which causes all `State` in a `StatefulWidget` to be lost. For example, If you want the scroll position to be restored the next time the route is displayed, then scroll position should be in a Store, not a StatefulWidget. | ||
|
|
||
| In contrast, an `Animation<>` would almost never go in a `Store` because animations are usually tightly tied to the lifetime of the current widget tree. |
| 1. **Can I just put everything into a single store?** | ||
|
|
||
| ## External Consumption | ||
| The library is unopinionated about how you organize your data and what you put in a Store. Practically speaking, with Stores delineated by entities, the change events broadcast by each store indicates that a set of entities has changed. Also, each store implements the business logic for a particular type of entity. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.