Ready to take your JavaScript development to the next level? Meet npm Enterprise - the ultimate in enterprise JavaScript. Learn more »


1.4.0-rc.2 • Public • Published


NPM version NPM downloads Build Status Dependency Status License Code Coverage Code Style


Redux bindings for Firebase. Includes Higher Order Component (HOC) for use with React.


The Material Example is deployed to


  • Integrated into redux
  • Support for updating and nested props
  • Population capability (similar to mongoose's populate or SQL's JOIN)
  • Out of the box support for authentication (with auto load user profile)
  • Firebase Storage Support
  • Support small data ( using value ) or large datasets ( using child_added, child_removed, child_changed )
  • queries support ( orderByChild, orderByKey, orderByValue, orderByPriority, limitToLast, limitToFirst, startAt, endAt, equalTo right now )
  • Automatic binding/unbinding
  • Declarative decorator syntax for React components
  • redux-thunk and redux-observable integrations
  • Action Types and other Constants exported for external use (such as in redux-observable)
  • Firebase v3+ support
  • Server Side Rendering Support


npm install --save react-redux-firebase

Before Use

Peer Dependencies

Install peer dependencies: npm i --save redux react-redux


Though they are optional, it is highly recommended that you use decorators with this library. The Simple Example shows implementation without decorators, while the Decorators Example shows the same application with decorators implemented.

A side by side comparison using react-redux's connect function/HOC is the best way to illustrate the difference:

Without Decorators

class SomeComponent extends Component {
export default connect()(SomeComponent)


With Decorators

export default class SomeComponent extends Component {

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 by doing the following:

  1. run npm i --save-dev babel-plugin-transform-decorators-legacy
  2. Add the following line to your .babelrc:
    "plugins": ["transform-decorators-legacy"]


Include reduxFirebase in your store compose function:

import { createStore, combineReducers, compose } from 'redux'
import { reactReduxFirebase, firebaseStateReducer } from 'react-redux-firebase'
// Add Firebase to reducers
const rootReducer = combineReducers({
  firebase: firebaseStateReducer
// Firebase config
const config = {
  apiKey: '<your-api-key>',
  authDomain: '<your-auth-domain>',
  databaseURL: '<your-database-url>',
  storageBucket: '<your-storage-bucket>'
// Add redux Firebase to compose
const createStoreWithFirebase = compose(
  reactReduxFirebase(config, { userProfile: 'users' }),
// Create store with reducers and initial state
const store = createStoreWithFirebase(rootReducer, initialState)

In components:

import React, { Component } from 'react'
import PropTypes from 'prop-types'
import { connect } from 'react-redux'
import {
} from 'react-redux-firebase'
  // { path: '/todos' } // object notation
  ({ firebase }) => ({
    // Connect todos prop to firebase todos
    todos: dataToJS(firebase, '/todos'),
export default class Todos extends Component {
  static propTypes = {
    todos: PropTypes.object,
    firebase: PropTypes.object
  render() {
    const { firebase, todos } = this.props;
    // Add a new todo to firebase
    const handleAdd = () => {
      const {newTodo} = this.refs
      firebase.push('/todos', { text:newTodo.value, done:false })
      newTodo.value = ''
    // Build Todos list if todos exist and are loaded
    const todosList = !isLoaded(todos)
      ? 'Loading'
      : isEmpty(todos)
        ? 'Todo list is empty'
        : Object.keys(todos).map(
            (key, id) => (
              <TodoItem key={key} id={id} todo={todos[key]}/>
    return (
        <input type="text" ref="newTodo" />
        <button onClick={handleAdd}>

Alternatively, if you choose not to use decorators:

import { compose } from 'redux'
export default compose(
    ({firebase}) => ({ todos: dataToJS(firebase, '/todos') })

Server Side Rendering

Firebase's library requires XML request capability, so if you are using react-redux-firebase in a Server Side rendering environment, make sure you require xmlhttprequest.

If you disagree with having to do this yourself, hop on gitter and let us know!

// needed to fix "Error: The XMLHttpRequest compatibility library was not found."
global.XMLHttpRequest = require('xmlhttprequest').XMLHttpRequest


See full documentation at


Examples folder is broken into two categories complete and snippets. /complete contains full applications that can be run as is, while /snippets contains small amounts of code to show functionality (dev tools and deps not included).

State Based Query Snippet

Snippet showing querying based on data in redux state. One of the most common examples of this is querying based on the current users auth UID.

Decorators Snippet

Snippet showing how to use decorators to simplify connect functions (redux's connect and react-redux-firebase's firebaseConnect)

Simple App Example

A simple example that was created using create-react-app's. Shows a list of todo items and allows you to add to them.

Material App Example

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


Join us on the redux-firebase gitter.

Using With Other Libraries


If you are using redux-thunk, make sure to set up your thunk middleware using it's redux-thunk's withExtraArgument method so that firebase is available within your actions. Here is an example createStore function that adds getFirebase as third argument along with a thunk that uses it:


import { applyMiddleware, compose, createStore } from 'redux';
import thunk from 'redux-thunk';
import { reactReduxFirebase, getFirebase } from 'react-redux-firebase';
import makeRootReducer from './reducers';
const fbConfig = {} // your firebase config
const config = {
  userProfile: 'users',
  enableLogging: false
const store = createStore(
      thunk.withExtraArgument(getFirebase) // Pass getFirebase function as extra argument
    reactReduxFirebase(fbConfig, config)


import { pathToJS } from 'react-redux-firebase'
export const addTodo = (newTodo) =>
  (dispatch, getState, getFirebase) => {
    const auth = pathToJS(getState.firebase, 'auth')
    newTodo.owner = auth.uid
      .push('todos', newTodo)
      .then(() => {
          type: 'TODO_CREATED',
          payload: newTodo


If you are using redux-observable, make sure to set up your redux-observable middleware so that firebase is available within your epics. Here is an example combineEpics function that adds getFirebase as third argument along with an epic that uses it:

import { getFirebase } from 'react-redux-firebase'
import { combineEpics } from 'redux-observable'
const rootEpic = (...args) =>
  combineEpics(somethingEpic, epic2)(..args, getFirebase)
// then later in your epics
const somethingEpic = (action$, store, getFirebase) =>
    .map(() =>
      getFirebase().push('somePath/onFirebase', { some: 'data' })


For full example, go to the Routing Recipes Section of the docs

In order to only allow authenticated users to view a page, a UserIsAuthenticated Higher Order Component can be created:

import { browserHistory } from 'react-router'
import { UserAuthWrapper } from 'redux-auth-wrapper'
import { pathToJS } from 'react-redux-firebase'
export const UserIsAuthenticated = UserAuthWrapper({
  wrapperDisplayName: 'UserIsAuthenticated',
  authSelector: ({ firebase }) => pathToJS(firebase, 'auth'),
  authenticatingSelector: ({ firebase }) =>
    pathToJS(firebase, 'isInitializing') === true ||
    pathToJS(firebase, 'auth') === undefined
  predicate: auth => auth !== null,
  redirectAction: (newLoc) => (dispatch) => {
      type: 'UNAUTHED_REDIRECT',
      payload: { message: 'You must be authenticated.' },

Then it can be used as a Higher Order Component wrapper on a component:

@UserIsAuthenticated // redirects to '/login' if user not is logged in
export default class ProtectedThing extends Component {
  render() {
    return (
        You are authed!

Starting A Project


generator-react-firebase is a yeoman generator uses react-redux-firebase when opting to include redux.

Complete Examples

The examples folder contains full applications that can be copied/adapted and used as a new project.


  1. How is this different than redux-react-firebase?

This library was actually originally forked from redux-react-firebase, but adds extended functionality such as:

#### Well why not combine? I have been talking to the author of 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 if you haven't already since a ton of this type of discussion goes on there.

  1. Why use redux if I have Firebase to store state?

This isn't a super quick answer, so I wrote up a medium article to explain

  1. Where can I find some examples?
  1. How does connect relate to firebaseConnect?

data flow

  1. How do I help?
  • Join the conversion on gitter
  • Post Issues
  • Create Pull Requests


Meet some of the outstanding companies and individuals that made it possible:



Special thanks to Tiberiu Craciun for creating redux-react-firebase, which this project was originally based on.


npm i react-redux-firebase

Downloadsweekly downloads








last publish


  • avatar
  • avatar
  • avatar
Report a vulnerability