Update README.md #1

jimbeveridge · 2016-09-30T20:35:26Z

No description provided.

sethladd · 2016-10-03T01:22:10Z

README.md

@@ -1,155 +1,236 @@
 # 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.


If you break the lines, it makes review much easier.

sethladd · 2016-10-03T01:23:05Z

README.md

@@ -1,155 +1,236 @@
 # 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.


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.

sethladd · 2016-10-03T01:23:49Z

README.md


-![flux-diagram](https://github.com/Workiva/w_flux/blob/images/images/flux_diagram.png)
+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.


I found it odd that you didn't mention State here.

sethladd · 2016-10-03T01:24:13Z

README.md


-`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:


They also make testing really difficult. (hard to dependency inject)

sethladd · 2016-10-03T01:25:04Z

README.md


---
+The Flux framework is designed to solve the problems above. The dataflow in flutter_flux looks like this.


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)

sethladd · 2016-10-03T01:29:39Z

README.md

-```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:


s/view (widgets)/widgets

sethladd · 2016-10-03T01:30:09Z

README.md

  }
+```
+
+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()`.


Who or what is making this call? "Once you've made this call" is hard to understand.

sethladd · 2016-10-03T01:30:48Z

README.md


-## Examples
+1.  **Where do I put View state, such as scroll positions?**


why capitalize View here? Is it a formal concept or class?

sethladd · 2016-10-03T01:31:02Z

README.md


+    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.


But when would it go into a store?

sethladd · 2016-10-03T01:32:05Z

README.md


-## 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.


unopinionated? or, agnostic?

Update README.md

fcdf5ff

sethladd reviewed Oct 3, 2016

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update README.md #1

Update README.md #1

jimbeveridge commented Sep 30, 2016

sethladd Oct 3, 2016

sethladd Oct 3, 2016

sethladd Oct 3, 2016

sethladd Oct 3, 2016

sethladd Oct 3, 2016

sethladd Oct 3, 2016

sethladd Oct 3, 2016

sethladd Oct 3, 2016

sethladd Oct 3, 2016

sethladd Oct 3, 2016


		![flux-diagram](https://github.com/Workiva/w_flux/blob/images/images/flux_diagram.png)
		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.


		---
		The Flux framework is designed to solve the problems above. The dataflow in flutter_flux looks like this.


		## Examples
		1. Where do I put View state, such as scroll positions?


		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.


		## 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.

Update README.md #1

Are you sure you want to change the base?

Update README.md #1

Conversation

jimbeveridge commented Sep 30, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment