props-firebase.md

props.firebase

props.firebase can be accessed on a component by wrapping it with the firebaseConnect higher order component like so:

import { firebaseConnect } from 'react-redux-firebase'

export default firebaseConnect()(SomeComponent)

// or with decorators

@firebaseConnect()
export default class SomeComponent extends Component {

}

The methods which are available are documented in firebaseInstance

set

Sets data to Firebase.

Parameters

• path String Path to location on Firebase which to set
• value (Object | String | Boolean | Number) Value to write to Firebase
• onComplete Function Function to run on complete (not required)

Examples

Basic

import React, { Component } from 'react'
import PropTypes from 'prop-types'
import { firebaseConnect } from 'react-redux-firebase'
const Example = ({ firebase: { set } }) => (
  <button onClick={() => set('some/path', { here: 'is a value' })}>
    Set To Firebase
  </button>
)
export default firebaseConnect()(Example)

Returns Promise Containing reference snapshot

push

Pushes data to Firebase.

Parameters

• path String Path to location on Firebase which to push
• value (Object | String | Boolean | Number) Value to push to Firebase
• onComplete Function Function to run on complete (not required)

Examples

Basic

import React, { Component } from 'react'
import PropTypes from 'prop-types'
import { firebaseConnect } from 'react-redux-firebase'
const Example = ({ firebase: { push } }) => (
  <button onClick={() => push('some/path', true)}>
    Push To Firebase
  </button>
)
export default firebaseConnect()(Example)

Returns Promise Containing reference snapshot

update

Updates data on Firebase and sends new data.

Parameters

• path String Path to location on Firebase which to update
• value (Object | String | Boolean | Number) Value to update to Firebase
• onComplete Function Function to run on complete (not required)

Examples

Basic

import React, { Component } from 'react'
import PropTypes from 'prop-types'
import { firebaseConnect } from 'react-redux-firebase'
const Example = ({ firebase: { update } }) => (
  <button onClick={() => update('some/path', { here: 'is a value' })}>
    Update To Firebase
  </button>
)
export default firebaseConnect()(Example)

Returns Promise Containing reference snapshot

remove

Removes data from Firebase at a given path.

Parameters

• path String Path to location on Firebase which to remove
• onComplete Function Function to run on complete (not required)

Examples

Basic

import React, { Component } from 'react'
import PropTypes from 'prop-types'
import { firebaseConnect } from 'react-redux-firebase'
const Example = ({ firebase: { remove } }) => (
  <button onClick={() => remove('some/path')}>
    Remove From Firebase
  </button>
)
export default firebaseConnect()(Example)

Returns Promise Containing reference snapshot

uniqueSet

Sets data to Firebase only if the path does not already exist. Otherwise, it rejects.

Parameters

• path String Path to location on Firebase which to set
• value (Object | String | Boolean | Number) Value to write to Firebase
• onComplete Function Function to run on complete (not required)

Examples

Basic

import React, { Component } from 'react'
import PropTypes from 'prop-types'
import { firebaseConnect } from 'react-redux-firebase'
const Example = ({ firebase: { uniqueSet } }) => (
  <button onClick={() => uniqueSet('some/unique/path', true)}>
    Unique Set To Firebase
  </button>
)
export default firebaseConnect()(Example)

Returns Promise Containing reference snapshot

uploadFile

Upload a file to Firebase Storage with the option to store its metadata in Firebase Database

Parameters

• path String Path to location on Firebase which to set
• file File File object to upload (usually first element from array output of select-file or a drag/drop onDrop)
• dbPath String Database path to place uploaded file metadata

Returns Promise Containing the File object

uploadFiles

Upload multiple files to Firebase Storage with the option to store their metadata in Firebase Database

Parameters

• path String Path to location on Firebase which to set
• files Array Array of File objects to upload (usually from a select-file or a drag/drop onDrop)
• dbPath String Database path to place uploaded files metadata.

Returns Promise Containing an array of File objects

deleteFile

Delete a file from Firebase Storage with the option to remove its metadata in Firebase Database

Parameters

• path String Path to location on Firebase which to set
• dbPath String Database path to place uploaded file metadata

Returns Promise Containing the File object

watchEvent

Watch event. Note: this method is used internally so examples have not yet been created, and it may not work as expected.

Parameters

• type String Type of watch event
• dbPath String Database path on which to setup watch event
• path
• storeAs String Name of listener results within redux store

Returns Promise

unWatchEvent

Unset a listener watch event. Note: this method is used internally so examples have not yet been created, and it may not work as expected.

Parameters

• eventName String Type of watch event
• eventPath String Database path on which to setup watch event
• storeAs String Name of listener results within redux store
• queryId (optional, default undefined)

Returns Promise

login

Logs user into Firebase. For examples, visit the auth section

Parameters

• credentials Object Credentials for authenticating
  • credentials.provider String External provider (google | facebook | twitter)
  • credentials.type String Type of external authentication (popup | redirect) (only used with provider)
  • credentials.email String Credentials for authenticating
  • credentials.password String Credentials for authenticating (only used with email)

Returns Promise Containing user's auth data

logout

Logs user out of Firebase and empties firebase state from redux store

Returns Promise

createUser

Creates a new user in Firebase authentication. If userProfile config option is set, user profiles will be set to this location.

Parameters

• credentials Object Credentials for authenticating
  • credentials.email String Credentials for authenticating
  • credentials.password String Credentials for authenticating (only used with email)
• profile Object Data to include within new user profile

Returns Promise Containing user's auth data

resetPassword

Sends password reset email

Parameters

• credentials Object Credentials for authenticating
  • credentials.email String Credentials for authenticating

Returns Promise

confirmPasswordReset

Confirm that a user's password has been reset

Parameters

• code String Password reset code to verify
• password String New Password to confirm reset to

Returns Promise

verifyPasswordResetCode

Verify that a password reset code from a password reset email is valid

Parameters

• code String Password reset code to verify

Returns Promise Containing user auth info

ref

Firebase ref function

Returns database.Reference Firebase database reference

auth

Firebase auth service instance including all Firebase auth methods

Returns Auth

database

Firebase database service instance including all Firebase storage methods

Returns Database Firebase database service

storage

Firebase storage service instance including all Firebase storage methods

Returns Storage Firebase storage service

messaging

Firebase messaging service instance including all Firebase messaging methods

Returns firebase.messaging Firebase messaging service