You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
**Do you want to request a *feature* or report a *bug*?**
2
2
3
-
(If this is a *usage question*, please **do not post it here**—post it on [gitter](https://gitter.im/redux-firebase/Lobby) or [Stack Overflow](http://stackoverflow.com/questions/tagged/react-redux-firebase) instead. If this is not a “feature” or a “bug”, or the phrase “How do I...?” applies, then it's probably a usage question.)
3
+
(If this is a *usage question*, please **do not post it here**—post it on [gitter](https://gitter.im/redux-firebase/Lobby). If this is not a “feature” or a “bug”, or the phrase “How do I...?” applies, then it's probably a usage question.)
4
4
5
5
6
6
**What is the current behavior?**
7
7
8
8
9
9
10
-
**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via https://jsfiddle.net or similar.**
10
+
**If the current behavior is a bug, please provide the steps to reproduce and if possible a minimal demo of the problem via [codesandbox](https://codesandbox.io/) or similar.**
11
11
12
12
13
13
@@ -18,4 +18,4 @@
18
18
**Which versions of dependencies, and which browser and OS are affected by this issue? Did this work in previous versions or setups?**
19
19
20
20
<!-- Love react-redux-firebase? Please consider supporting our collective:
The above install command will install the `@latest` tag. You may also use the following tags when installing to get different versions:
47
47
48
-
*`@next` - Next upcoming release. Currently points to active progress with `v1.5.0-*` pre-releases
49
-
*`@canary` - Most possible up to date code. Currently points to active progress with `v2.0.0-*` pre-releases. *Warning:* Syntax is different than current stable version.
48
+
*`@canary` - Most possible up to date code. Currently, points to active progress with `v2.0.0-*` pre-releases. *Warning:* Syntax is different than current stable version.
50
49
51
-
Other versions docs are available using the dropdown on the above docs link. For quick access:
Be aware of changes when using version that are tagged `@latest`. Please report any issues you encounter, and try to keep an eye on the [releases page](https://github.com/prescottprue/react-redux-firebase/releases) for updates.
50
+
Be aware of changes when using a version that is not tagged `@latest`. Please report any issues you encounter, and try to keep an eye on the [releases page](https://github.com/prescottprue/react-redux-firebase/releases) for updates.
56
51
57
52
## Use
58
53
59
-
**Note:** If you are just starting a new project, you may want to use [`v2.0.0`](http://docs.react-redux-firebase.com/history/v2.0.0/#use) since it is has an even easier syntax. For clarity on the transition, view the [`v1` -> `v2` migration guide](http://docs.react-redux-firebase.com/history/v2.0.0/docs/v2-migration-guide.html)
54
+
**Note:** If you are just starting a new project, you may want to use [`v2.0.0`](http://docs.react-redux-firebase.com/history/v2.0.0/#use) since it has an even easier syntax. For clarity on the transition, view the [`v1` -> `v2` migration guide](http://docs.react-redux-firebase.com/history/v2.0.0/docs/v2-migration-guide.html)
60
55
61
56
Include `reactReduxFirebase` in your store compose function and `firebaseStateReducer` in your reducers:
In order to enable this functionality, you will most likely need to install a plugin (depending on your build setup). For Webpack and Babel, you will need to make sure you have installed and enabled [babel-plugin-transform-decorators-legacy](https://github.com/loganfsmyth/babel-plugin-transform-decorators-legacy) by doing the following:
198
+
To enable this functionality, you will most likely need to install a plugin (depending on your build setup). For Webpack and Babel, you will need to make sure you have installed and enabled [babel-plugin-transform-decorators-legacy](https://github.com/loganfsmyth/babel-plugin-transform-decorators-legacy) by doing the following:
201
199
202
200
1. run `npm i --save-dev babel-plugin-transform-decorators-legacy`
203
201
2. Add the following line to your `.babelrc`:
@@ -245,7 +243,7 @@ Join us on the [redux-firebase gitter](https://gitter.im/redux-firebase/Lobby).
@@ -267,33 +265,37 @@ The [examples folder](/examples) contains full applications that can be copied/a
267
265
268
266
1. How is this different than [`redux-react-firebase`](https://github.com/tiberiuc/redux-react-firebase)?
269
267
270
-
This library was actually originally forked from redux-react-firebase, but adds extended functionality such as:
271
-
*[populate functionality](http://react-redux-firebase.com/docs/populate) (similar to mongoDB or SQL JOIN)
272
-
*`react-native` support ([web/js](http://react-redux-firebase.com/docs/recipes/react-native.html) or native modules through [`react-native-firebase`](http://docs.react-redux-firebase.com/history/v2.0.0/docs/recipes/react-native.html#native-modules))
273
-
* tons of [integrations](#integrations)
274
-
*[`profileFactory`](http://react-redux-firebase.com/docs/config) - change format of profile stored on Firebase
275
-
*[`getFirebase`](http://react-redux-firebase.com/docs/thunks) - access to firebase instance that fires actions when methods are called
276
-
*[access to firebase's `storage`](http://react-redux-firebase.com/docs/storage) method`
277
-
*`uniqueSet` method helper for only setting if location doesn't already exist
278
-
* Object or String notation for paths (`[{ path: '/todos' }]` equivalent to `['/todos']`)
279
-
* Action Types and other Constants are exposed for external usage (such as with `redux-observable`)
280
-
* Server Side Rendering Support
281
-
*[Complete Firebase Auth Integration](http://react-redux-firebase.com/docs/auth.html#examples) including `signInWithRedirect` compatibility for OAuth Providers
282
-
283
-
#### Well why not combine?
284
-
I have been talking to the author of [redux-react-firebase](https://github.com/tiberiuc/redux-react-firebase) about combining, but we are not sure that the users of both want that at this point. Join us on the [redux-firebase gitter](https://gitter.im/redux-firebase/Lobby) if you haven't already since a ton of this type of discussion goes on there.
268
+
This library was actually originally forked from redux-react-firebase, but adds extended functionality such as:
269
+
*[populate functionality](http://react-redux-firebase.com/docs/populate) (similar to mongoose's `populate` or SQL's `JOIN`)
270
+
*`react-native` support ([web/js](http://react-redux-firebase.com/docs/recipes/react-native.html) or native modules through [`react-native-firebase`](http://docs.react-redux-firebase.com/history/v2.0.0/docs/recipes/react-native.html#native-modules))
271
+
* tons of [integrations](#integrations)
272
+
*[`profileFactory`](http://react-redux-firebase.com/docs/config) - change format of profile stored on Firebase
273
+
*[`getFirebase`](http://react-redux-firebase.com/docs/thunks) - access to firebase instance that fires actions when methods are called
274
+
*[access to firebase's `storage`](http://react-redux-firebase.com/docs/storage) and `messaging` services
275
+
*`uniqueSet` method helper for only setting if location doesn't already exist
276
+
* Object or String notation for paths (`[{ path: '/todos' }]` equivalent to `['/todos']`)
277
+
* Action Types and other Constants are exposed for external usage (such as with `redux-observable`)
278
+
* Server Side Rendering Support
279
+
*[Complete Firebase Auth Integration](http://react-redux-firebase.com/docs/auth.html#examples) including `signInWithRedirect` compatibility for OAuth Providers
280
+
281
+
#### Well why not combine?
282
+
I have been talking to the author of [redux-react-firebase](https://github.com/tiberiuc/redux-react-firebase) about combining, but we are not sure that the users of both want that at this point. Join us on the [redux-firebase gitter](https://gitter.im/redux-firebase/Lobby) if you haven't already since a ton of this type of discussion goes on there.
283
+
284
+
#### What about [redux-firebase](https://github.com/colbyr/redux-firebase)?
285
+
The author of [redux-firebase](https://github.com/colbyr/redux-firebase) has agreed to share the npm namespace! Currently the plan is to take the framework agnostic redux core logic of `react-redux-firebase` and [place it into `redux-firebase`](https://github.com/prescottprue/redux-firebase)). Eventually `react-redux-firebase` and potentially other framework libraries can depend on that core (the new `redux-firebase`).
285
286
286
287
2. Why use redux if I have Firebase to store state?
287
288
288
-
This isn't a super quick answer, so I wrote up [a medium article to explain](https://medium.com/@prescottprue/firebase-with-redux-82d04f8675b9)
289
+
This isn't a super quick answer, so I wrote up [a medium article to explain](https://medium.com/@prescottprue/firebase-with-redux-82d04f8675b9)
289
290
290
291
3. Where can I find some examples?
291
292
292
-
*[Recipes Section](http://react-redux-firebase.com/docs/recipes/) of [the docs](http://react-redux-firebase.com/docs/recipes/)
293
-
*[examples folder](/examples) contains [complete example apps](/examples/complete) as well as [useful snippets](/examples/snippets)
293
+
*[Recipes Section](http://react-redux-firebase.com/docs/recipes/) of [the docs](http://react-redux-firebase.com/docs/recipes/)
294
+
*[examples folder](/examples) contains [complete example apps](/examples/complete) as well as [useful snippets](/examples/snippets)
295
+
294
296
4. How does `connect` relate to `firebaseConnect`?
Copy file name to clipboardExpand all lines: docs/api/compose.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ Middleware that handles configuration (placed in redux's
54
54
automatically populate profile with data loaded through profileParamsToPopulate config. (default: `true`)
55
55
-`config.setProfilePopulateResults`**[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)** Whether or not to
56
56
call SET actions for data that results from populating profile to redux under
57
-
the data path. For example: role paramter on profile populated from 'roles'
57
+
the data path. For example role parameter on profile populated from 'roles'
58
58
root. True will call SET_PROFILE as well as a SET action with the role that
59
59
is loaded (places it in data/roles). (default: `false`)
-`updateProfileOnLogin`**[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**`true` Whether or not to update
87
87
user profile when logging in.
88
+
-`resetBeforeLogin`**[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**`true` Whether or not to reset auth
89
+
and profile when logging in (see issue #254 for more details).
88
90
-`enableRedirectHandling`**[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**`true` Whether or not to enable
89
91
redirect handling. This must be disabled if environment is not http/https
90
92
such as with react-native.
@@ -98,7 +100,7 @@ Default configuration options
98
100
profileParamsToPopulate config.
99
101
-`setProfilePopulateResults`**[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**`true` Whether or not to
100
102
call SET actions for data that results from populating profile to redux under
101
-
the data path. For example: role paramter on profile populated from 'roles'
103
+
the data path. For example role parameter on profile populated from 'roles'
102
104
root. True will call SET_PROFILE as well as a SET action with the role that
103
105
is loaded (places it in data/roles).
104
106
-`dispatchOnUnsetListener`**[Boolean](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean)**`false` Whether or not to
0 commit comments