Reactfire NPM | npm.io

4.2.3 • Published 2 years ago

Install

Weekly downloads

3,377

License

MIT

Repository

Last release

2 years ago

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

AuthCheckProps

Property	Type
auth	Auth
children	React.Component
fallback	React.Component
requiredClaims	Object

SuspensePerfProps

Property	Type
children	React.Component
fallback	React.Component
firePerf	any
traceId	string

ReactFireOptions

Property	Type
startWithValue	any

Components

`AuthCheck`

Props

interface AuthCheckProps

Returns

React.FunctionComponent

`SuspenseWithPerf`

Props

interface SuspensePerfProps

Returns

React.FunctionComponent

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

`useObservable`

Parameters

Parameter	Type
observable\$	Observable
observableId	string
startWithValue ?	any

Returns

any

For development

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

Testing

cd into the reactfire/reactfire directory
run yarn test

rxfire rxjs use-sync-external-store

@infinitebrahmanuniverse/nolb-reactf @everything-registry/sub-chunk-2626 sales-sync-mobile usapan fireschema fireschema-dart @pegasis/fireschema @owlprotocol/ui-react @rng-apps/utils @rng-associates/accounts @rng-associates/firesource

4.2.3-exp.9429194

2 years ago

4.2.3-exp.a1d5930

2 years ago

4.2.3-exp.1769cfb

2 years ago

4.2.3-exp.3f13a86

2 years ago

4.2.3-exp.8d83c9e

2 years ago

2 years ago

4.2.3-exp.85cb2bb

2 years ago

4.2.3-exp.c7357da

2 years ago

4.2.3-exp.4329c43

2 years ago

4.2.3-exp.9801ee9

2 years ago

4.2.3-exp.6734b6a

3 years ago

4.0.1-exp.f6d2351

3 years ago

4.2.3-exp.9754f86

3 years ago

3 years ago

4.2.2-exp.414201e

3 years ago

4.0.0-exp.eb1428b

3 years ago

4.0.0-exp.f654109

4 years ago

4 years ago

4.0.0-exp.b2c2859

4 years ago

4 years ago

4.0.0-exp.7eded08

4 years ago

4.0.0-exp.8f8fd08

4 years ago

4.0.0-exp.a359de4

4 years ago

4.0.0-exp.8596428

4 years ago

4.0.0-exp.4929283

4 years ago

4 years ago

4.0.0-exp.14d368b

4 years ago

4.0.0-exp.6fa717e

4 years ago

4 years ago

4.0.0-exp.24320c4

4 years ago

4.0.0-exp.8c7539a

4 years ago

4 years ago

4.0.0-exp.3cb4468

4 years ago

4 years ago

4.0.0-exp.b6c8eeb

4 years ago

4.0.0-exp.cc0c93e

4 years ago

4.0.0-exp.f9fa66a

4 years ago

4.0.0-exp.0e1a7fe

4 years ago

4.0.0-exp.88561a1

4 years ago

4.0.0-exp.76651c1

4 years ago

4.0.0-exp.cb3fede

4 years ago

4.0.0-exp.e80fc49

4 years ago

4.0.0-exp.7c0921e

4 years ago

4 years ago

4 years ago

4 years ago

4.0.0-exp.a2d2f1c

4 years ago

4.0.0-exp.560ab00

4 years ago

4.0.0-exp.8c886da

4 years ago

4.0.0-exp.2b31a5a

4 years ago

4.0.0-exp.2c0d936

4 years ago

4.0.0-canary.2ea407e

4 years ago

3.0.0-canary.80223d6

4 years ago

4.0.0-canary.771c71e

4 years ago

4.0.0-canary.2be5e8b

4 years ago

4.0.0-canary.cd440c1

4 years ago

4.0.0-canary.c149628

4 years ago

4.0.0-canary.a01351b

4 years ago

4 years ago

3.0.0-canary.804b3e5

4 years ago

4.0.0-canary.9a8916f

4 years ago

3.0.0-canary.9605ad0

4 years ago

4 years ago

3.0.0-canary.4d1206d

4 years ago

4 years ago

3.0.0-canary.8188802

4 years ago

3.0.0-canary.8d36acd

5 years ago

3.0.0-canary.04047d4

5 years ago

3.0.0-canary.205772f

5 years ago

3.0.0-canary.d1af3db

5 years ago

3.0.0-canary.6f5c1d4

5 years ago

3.0.0-canary.3ffc3b7

5 years ago

3.0.0-canary.453b7dd

5 years ago

3.0.0-canary.66f4089

5 years ago

3.0.0-canary.cb46944

5 years ago

3.0.0-canary.f623d86

5 years ago

5 years ago

3.0.0-canary.814bfc0

5 years ago

3.0.0-canary.d6c70c8

5 years ago

3.0.0-canary.b0f2f95

5 years ago

3.0.0-canary.9046a0a

5 years ago

3.0.0-canary.4d0703d

5 years ago

3.0.0-canary.356f716

5 years ago

3.0.0-alpha-canary.68f6a47

5 years ago

3.0.0-alpha-canary.5fe6c77

5 years ago

3.0.0-alpha-canary.c86d524

5 years ago

2.0.0-canary.68cfc79

5 years ago

2.0.0-canary.2b6f8e8

6 years ago

2.0.0-canary.e32aa40

6 years ago

2.0.0-canary.d4d4476

6 years ago

6 years ago

2.0.0-canary.848eaa3

6 years ago

2.0.0-canary.c305e3d

6 years ago

6 years ago

2.0.0-canary.80b9431

6 years ago

6 years ago

2.0.0-canary.5487096

6 years ago

6 years ago

2.0.0-canary.325415e

6 years ago

6 years ago

2.0.0-canary.51baa22

6 years ago

2.0.0-canary.ce716fe

6 years ago

2.0.0-canary.8a54d42

6 years ago

2.0.0-canary.32c2bb3

6 years ago

2.0.0-canary.c67dfa7

6 years ago

6 years ago

2.0.0-canary.e6962e3

6 years ago

2.0.0-canary.3cebaa9

6 years ago

2.0.0-canary.aa0f822

6 years ago

2.0.0-canary.d1068fe

6 years ago

2.0.0-canary.64d26c0

6 years ago

6 years ago

2.0.0-canary.66246ca

6 years ago

2.0.0-canary.11d6a19

6 years ago

2.0.0-canary.121f5e1

6 years ago

2.0.0-canary.e2f1b1f

6 years ago

2.0.0-canary.f417133

6 years ago

6 years ago

2.0.0-canary.33f1e6a

6 years ago

2.0.0-canary.f3e731d

6 years ago

2.0.0-canary.1fce6b9

6 years ago

2.0.0-canary.592457e

6 years ago

2.0.0-canary.99b729e

6 years ago

2.0.0-canary.3875691

6 years ago

2.0.0-canary.d96bda4

6 years ago

2.0.0-canary.6bf1f31

6 years ago

2.0.0-canary.49437e1

6 years ago

2.0.0-canary.fa4e20e

6 years ago

2.0.0-canary.72b1c2d

6 years ago

2.0.0-canary.459d524

6 years ago

2.0.0-canary.0a4789a

6 years ago

2.0.0-canary.803159c

6 years ago

2.0.0-canary.99dac6c

6 years ago

2.0.0-canary.0916a27

6 years ago

2.0.0-canary.3462ec5

6 years ago

2.0.0-canary.473760c

6 years ago

2.0.0-canary.d3d9bfc

6 years ago

2.0.0-canary.a721fff

6 years ago

2.0.0-canary.98cc419

6 years ago

2.0.0-canary.70ef0ac

6 years ago

6 years ago

6 years ago

2.0.0-canary.fc2be5b

6 years ago

2.0.0-canary.e15c0fb

6 years ago

2.0.0-canary.d5a1543

6 years ago

2.0.0-canary.0aa4d65

6 years ago

2.0.0-canary.2182139

6 years ago

2.0.0-canary.4e7a12f

6 years ago

2.0.0-canary.60b2440

6 years ago

2.0.0-canary.373b1e3

6 years ago

2.0.0-canary.6704d04

6 years ago

2.0.0-canary.a7cd92a

6 years ago

2.0.0-canary.ec20061

6 years ago

2.0.0-canary.6d527eb

6 years ago

2.0.0-canary.dafc6ea

6 years ago

2.0.0-canary.3f6d524

6 years ago

2.0.0-canary.b0d6bfa

6 years ago

2.0.0-canary.dde79a5

6 years ago

2.0.0-canary.5b16b83

6 years ago

1.0.0-canary.5b16b83

6 years ago

1.0.0-canary.aa8c678

6 years ago

1.0.0-canary.f95f95f

6 years ago

6 years ago

1.0.0-canary.441a400

6 years ago

1.0.0-canary.a704a07

6 years ago

9 years ago

10 years ago

10 years ago

10 years ago

10 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago

11 years ago