Reactfire

Hooks that make it easy to interact with Firestore, Realtime Database, Authentication, and Storage. Note, every reactfire hook throws a Promise until it has connected to Firebase. Wrap your components in React's Suspense, or, if you don't want to deal with Suspense, pass an initial value to a reactfire hook. Example.

Interfaces

ReactFireOptions

Property	Type
startWithValue	any

Hooks

useDatabaseList

Subscribe to a Realtime Database list

Parameters

Parameter	Type
ref	Reference or Query
options ?	ReactFireOptions

Returns

QueryChange[]

useDatabaseObject

Subscribe to a Realtime Database object

Parameters

Parameter	Type
ref	Reference
options ?	ReactFireOptions

Returns

QueryChange

useFirestoreCollection

Subscribe to a Firestore collection

Parameters

Parameter	Type
ref	CollectionReference
options ?	ReactFireOptions

Returns

QuerySnapshot

useFirestoreDoc

Suscribe to Firestore Document changes

Parameters

Parameter	Type
ref	DocumentReference
options ?	ReactFireOptions

Returns

DocumentSnapshot

useStorageDownloadURL

Subscribe to a storage ref's download URL

Parameters

Parameter	Type
ref	Reference
options ?	ReactFireOptions

Returns

string

useStorageTask

Subscribe to the progress of a storage task

Parameters

Parameter	Type
task	UploadTask
ref	Reference
options ?	ReactFireOptions

Returns

UploadTaskSnapshot

useUser

Subscribe to Firebase auth state changes, including token refresh

Parameters

Parameter	Type
auth	Auth
options ?	ReactFireOptions

Returns

User

For development

1. yarn install
2. cd into the reactfire/reactfire directory. run yarn run watch.
3. In a new terminal, cd into the reactfire/sample-simple directory. run yarn start.
4. Head over to https://localhost:3000 to see the running sample

Testing

1. cd into the reactfire/reactfire directory
2. run yarn test