Redux bindings for Firebase. Includes Higher Order Component (HOC) for use with React.
The Material Example is deployed to demo.react-redux-firebase.com.
- Integrated into redux
- Out of the box support for authentication (with auto load user profile)
- Full Firebase Platform Support Including Real Time Database, Firestore, and Storage
- Automatic binding/unbinding of listeners through React Higher Order Components (
firebaseConnectandfirestoreConnect) - Population capability (similar to mongoose's
populateor SQL'sJOIN) - Support small data ( using
value) or large datasets ( usingchild_added,child_removed,child_changed) - Multiple queries types supported including
orderByChild,orderByKey,orderByValue,orderByPriority,limitToLast,limitToFirst,startAt,endAt,equalTo - Tons of examples of integrations including
redux-thunkandredux-observable - Server Side Rendering Support
react-nativesupport using native modules or web sdk
npm install --save react-redux-firebaseThis assumes you are using npm as your package manager.
If you're not, you can access the library on unpkg, download it, or point your package manager to it. Theres more on this in the Builds section below.
Include firebaseReducer (reducer) while creating your redux store then pass dispatch and your firebase instance to ReactReduxFirebaseProvider (context provider):
import React from 'react'
import { render } from 'react-dom'
import { Provider } from 'react-redux'
import firebase from 'firebase/app'
import 'firebase/auth'
// import 'firebase/firestore' // <- needed if using firestore
// import 'firebase/functions' // <- needed if using httpsCallable
import { createStore, combineReducers, compose } from 'redux'
import { ReactReduxFirebaseProvider, firebaseReducer } from 'react-redux-firebase'
// import { createFirestoreInstance, firestoreReducer } from 'redux-firestore' // <- needed if using firestore
const fbConfig = {}
// react-redux-firebase config
const rrfConfig = {
userProfile: 'users',
// useFirestoreForProfile: true // Firestore for Profile instead of Realtime DB
}
// Initialize firebase instance
firebase.initializeApp(fbConfig)
// Initialize other services on firebase instance
// firebase.firestore() // <- needed if using firestore
// firebase.functions() // <- needed if using httpsCallable
// Add firebase to reducers
const rootReducer = combineReducers({
firebase: firebaseReducer,
// firestore: firestoreReducer // <- needed if using firestore
})
// Create store with reducers and initial state
const initialState = {}
const store = createStore(rootReducer, initialState)
const rrfProps = {
firebase,
config: rrfConfig,
dispatch: store.dispatch,
// createFirestoreInstance // <- needed if using firestore
}
// Setup react-redux so that connect HOC can be used
const App = () => (
<Provider store={store}>
<ReactReduxFirebaseProvider {...rrfProps}>
<Todos />
</ReactReduxFirebaseProvider>
</Provider>
);
render(<App/>, document.getElementById('root'));The Firebase instance can then be grabbed from context within your components (withFirebase and firebaseConnect Higher Order Components provided to help):
Add Data
import React from 'react'
import PropTypes from 'prop-types'
import { withFirebase } from 'react-redux-firebase'
import { compose, withHandlers } from 'recompose'
function Todos({ firebase, addSampleTodo }) {
return (
<div>
<h1>New Sample Todo</h1>
<button onClick={addSampleTodo}>
Add
</button>
</div>
)
}
const enhance = compose(
withFirebase,
withHandlers({
addSampleTodo: props => () => {
const sampleTodo = { text: 'Sample', done: false }
return props.firebase.push('todos', sampleTodo)
}
})
)
export default enhance(Todos)Load Data (listeners automatically managed on mount/unmount)
import React from 'react'
import PropTypes from 'prop-types'
import { connect } from 'react-redux'
import { compose } from 'redux'
import { firebaseConnect, isLoaded, isEmpty } from 'react-redux-firebase'
function Todos({ todos, firebase }) {
if (!isLoaded(todos)) {
return <div>Loading...</div>
}
if (isEmpty(todos)) {
return <div>Todos List Is Empty</div>
}
return (
<div>
<ul>
{
Object.keys(todos).map(
(key, id) => (
<TodoItem key={key} id={id} todo={todos[key]}/>
)
)
}
</ul>
</div>
)
}
export default compose(
firebaseConnect(() => [
'todos' // { path: '/todos' } // object notation
]),
connect((state) => ({
todos: state.firebase.data.todos,
// profile: state.firebase.profile // load profile
}))
)(Todos)Queries Based On Props
It is common to make a detail page that loads a single item instead of a whole list of items. A query for a specific Todos can be created using
import React from 'react'
import PropTypes from 'prop-types'
import { connect } from 'react-redux'
import { firebaseConnect, getVal } from 'react-redux-firebase'
import { compose, withHandlers } from 'recompose'
// Component enhancer that loads todo into redux then into the todo prop
const enhance = compose(
firebaseConnect((props) => {
// Set listeners based on props (prop is route parameter from react-router in this case)
return [
{ path: `todos/${props.params.todoId}` }, // create todo listener
// `todos/${props.params.todoId}` // equivalent string notation
]
}),
connect(({ firebase }, props) => ({
todo: getVal(firebase, `data/todos/${props.params.todoId}`), // lodash's get can also be used
})),
withHandlers({
updateTodo: props => () => {
return firebase.update(`todos/${params.todoId}`, { done: !todo.isDone })
}
})
)
function Todo({ todo }) {
return (
<div>
<input
name="isDone"
type="checkbox"
checked={todo.isDone}
onChange={updateTodo}
/>
<span>{todo.label}</span>
</div>
)
}
// Export enhanced component
export default enhance(Todo)Load Data On Click
import React from 'react'
import PropTypes from 'prop-types'
import { connect } from 'react-redux'
import { compose } from 'redux'
import { withFirebase, isLoaded, isEmpty } from 'react-redux-firebase'
function TodosList({ todos }) {
if (!isLoaded(todos)) {
return <div>Loading...</div>
}
if (isEmpty(todos)) {
return <div>Todos List Is Empty</div>
}
return (
<ul>
{
Object.keys(todos).map((key, id) =>
<TodoItem key={key} id={id} todo={todos[key]}/>
)
}
</ul>
)
}
const withTodosData = compose(
withFirebase, // or firebaseConnect()
connect((state) => ({
todos: state.firebase.data.todos,
// profile: state.firebase.profile // load profile
}))
)
const EnhancedTodosList = withTodosData(TodosList)
function Todos({ firebase }) {
return (
<div>
<h1>Todos</h1>
<EnhancedTodosList />
<button onClick={() => firebase.watchEvent('value', 'todos')}>
Load Todos
</button>
</div>
)
}
// Export enhanced component
export default withFirebase(Todos)If you plan to use Firestore, you should checkout redux-firestore. It integrates nicely with react-redux-firebase and it allows you to run Real Time Database and Firestore along side each other.
react-redux-firebase provides the firestoreConnect HOC (similar to firebaseConnect) for easy setting/unsetting of listeners.
Currently react-redux-firebase still handles auth when using redux-firestore - The future plan is to also have auth standalone auth library that will allow the developer to choose which pieces they do/do not want.
See full documentation at react-redux-firebase.com
- fireadmin.io - Firebase Instance Management Tool (source available here)
If you would like a project added to this section please reach out over gitter
Examples folder is broken into two categories snippets and complete. /complete contains full applications that can be run as is, where as /snippets contains small amounts of code to highlight specific functionality (dev tools and deps not included).
Snippet showing querying based on data in redux state. One of the more common examples is querying based on the current users auth UID.
Snippet showing how to use decorators to simplify connect functions (redux's connect and react-redux-firebase's firebaseConnect)
A simple example that was created using create-react-app's. Shows a list of todo items and allows you to add to them.
An example that user Material UI built on top of the output of create-react-app's eject command. Shows a list of todo items and allows you to add to them. This is what is deployed to redux-firebasev3.firebaseapp.com.
Join us on the redux-firebase gitter.
View docs for recipes on integrations with:
- redux-firestore
- redux-thunk
- redux-observable
- redux-saga
- redux-form
- redux-auth-wrapper
- redux-persist
- react-native
- react-native-firebase
generator-react-firebase is a yeoman generator uses react-redux-firebase when opting to include redux.
The examples folder contains full applications that can be copied/adapted and used as a new project.
Please visit the FAQ section of the docs
Most commonly people consume Redux Firestore as a CommonJS module. This module is what you get when you import redux in a Webpack, Browserify, or a Node environment.
If you don't use a module bundler, it's also fine. The redux-firestore npm package includes precompiled production and development UMD builds in the dist folder. They can be used directly without a bundler and are thus compatible with many popular JavaScript module loaders and environments. For example, you can drop a UMD build as a <script> tag on the page. The UMD builds make Redux Firestore available as a window.ReactReduxFirebase global variable.
It can be imported like so:
<script src="../node_modules/react-redux-firebase/dist/react-redux-firebase.min.js"></script>
<script src="../node_modules/redux-firestore/dist/redux-firestore.min.js"></script>
<!-- or through cdn: <script src="https://unpkg.com/react-redux-firebase@latest/dist/react-redux-firebase.min.js"></script> -->
<!-- or through cdn: <script src="https://unpkg.com/redux-firestore@latest/dist/redux-firestore.min.js"></script> -->
<script>console.log('react redux firebase:', window.ReactReduxFirebase)</script>Note: In an effort to keep things simple, the wording from this explanation was modeled after the installation section of the Redux Docs.
This project exists thanks to all the people who contribute.
Thank you to all our backers! 🙏