Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/unfold/react-firebase

React bindings for Firebase
https://github.com/unfold/react-firebase

firebase higher-order-component react react-bindings

Last synced: 4 months ago
JSON representation

React bindings for Firebase

Awesome Lists containing this project

README 

        
React Firebase

==============



React bindings for [Firebase](https://firebase.google.com).



__:warning: React Firebase in not maintained anymore__

> There might come a replacement from [React itself](

https://github.com/unfold/react-firebase/issues/57#issuecomment-644762819) with Suspense, but when is not certain. If you want to contribute or maintain this project, send a message to @einarlove.



## Installation



```

npm install --save react-firebase

```



React Firebase requires **[React 0.14](https://github.com/facebook/react) and [Firebase 3](https://www.npmjs.com/package/firebase) or later.**



## Example



```js

import React from 'react'

import firebase from 'firebase'

import { connect } from 'react-firebase'



firebase.initializeApp({

  databaseURL: 'https://react-firebase-sandbox.firebaseio.com'

})



const Counter = ({ value, setValue }) => (

  


     setValue(value - 1)}>-

    {value}

     setValue(value + 1)}>+

  


)



export default connect((props, ref) => ({

  value: 'counterValue',

  setValue: value => ref('counterValue').set(value)

}))(Counter)

```



## Test for yourself on Codepen.io

- [Get started template](https://codepen.io/einarlove/pen/peoMbp?editors=1010)

- [Counter example](https://codepen.io/einarlove/pen/RpwXGP?editors=1010)



## Usage



### `connect([mapFirebaseToProps], [mergeProps])`



Connects a React component to a Firebase App reference.



It does not modify the component class passed to it. Instead, it *returns* a new, connected component class, for you to use.



#### Arguments



* [`mapFirebaseToProps(props, ref, firebaseApp): subscriptions`] \(*Object or Function*): Its result, or the argument itself must be a plain object. Each value must either be a path to a location in your database, a query object or a function. If you omit it, the default implementation just passes `firebaseApp` as a prop to your component.



* [`mergeProps(ownProps, firebaseProps): props`] \(*Function*): If specified, it is passed the parent `props` and current subscription state merged with the result of `mapFirebaseToProps()`. The plain object you return from it will be passed as props to the wrapped component. If you omit it, `Object.assign({}, ownProps, firebaseProps)` is used by default.



#### Returns



A React component class that passes subscriptions and actions as props to your component according to the specified options.



> Note: "actions" are any function values returned by `mapFirebaseToProps()` which are typically used to modify data in Firebase.



##### Static Properties



* `WrappedComponent` *(Component)*: The original component class passed to `connect()`.



##### Pass `todos` as a prop



  > Note: The value of `todos` is the path to your data in Firebase. This is equivalent to `firebase.database().ref('todo')`.



```js

const mapFirebaseToProps = {

  todos: 'todos'

}



export default connect(mapFirebaseToProps)(TodoApp)

```



#####  Pass `todos` and a function that adds a new todo (`addTodo`) as props



```js

const mapFirebaseToProps = (props, ref) => ({

  todos: 'todos',

  addTodo: todo => ref('todos').push(todo)

})



export default connect(mapFirebaseToProps)(TodoApp)

```



#####  Pass `todos`, `completedTodos`, a function that completes a todo (`completeTodo`) and one that logs in as props



```js

const mapFirebaseToProps = (props, ref, firebase) => ({

  todos: 'todos',

  completedTodos: {

    path: 'todos',

    orderByChild: 'completed',

    equalTo: true

  },

  completeTodo = id => ref(`todos/${id}/completed`).set(true),

  login: (email, password) => firebase.auth().signInWithEmailAndPassword(email, password)

})



export default connect(mapFirebaseToProps)(TodoApp)

```



### ``



By default `connect()` will use the [default Firebase App](https://firebase.google.com/docs/reference/js/firebase.app). If you have multiple Firebase App references in your application you may use this to specify the Firebase App reference available to `connect()` calls in the component hierarchy below.



If you *really* need to, you can manually pass `firebaseApp` as a prop to every `connect()`ed component, but we only recommend to do this for stubbing `firebaseApp` in unit tests, or in non-fully-React codebases. Normally, you should just use ``.



#### Props



* `firebaseApp` (*[App](https://firebase.google.com/docs/reference/js/firebase.app.App)*): A Firebase App reference.

* `children` (*ReactElement*): The root of your component hierarchy.



#### Example



```js

import { Provider } from 'react-firebase'

import { initializeApp } from 'firebase'



const firebaseApp = initializeApp({

  databaseURL: 'https://my-firebase.firebaseio.com'

})



ReactDOM.render(

  

    

  ,

  rootEl

)

```



## License



MIT



## Acknowledgements



[`react-redux`](https://github.com/reactjs/react-redux) which this library is heavily inspired by.