Skip to content

Commit 9073d36

Browse files
committed
More documentation tweaks
1 parent 97b86bd commit 9073d36

File tree

4 files changed

+9
-1
lines changed

4 files changed

+9
-1
lines changed

auth/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
React Firebase Hooks provides a convenience listener for Firebase Auth's auth state. The hook wraps around the `firebase.auth().onAuthStateChange()` method to ensure that it is always up to date.
44

5+
List of Auth hooks:
6+
57
- [useAuthState](#useauthstateauth)
68

79
### `useAuthState(auth)`

database/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Firebase Realtime Database. The hooks wrap around the `firebase.database().ref()
66
In addition to returning the list or value, the hooks provide an `error` and `loading` property
77
to give a complete lifecycle for loading and listening to the Realtime Database.
88

9+
List of Realtime Database hooks:
10+
911
- [useList](#uselistref)
1012
- [useListKeys](#uselistkeystref)
1113
- [useListVals](#uselistvalstref-keyfield)

firestore/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ There are 2 variants of each hook:
1212
- `useX` which subscribes to the underlying Collection or Document and listens for changes
1313
- `useXOnce` which reads the current value of the Collection or Document
1414

15+
List of Cloud Firestore hooks:
16+
1517
- [useCollection](#usecollectionquery-options)
1618
- [useCollectionOnce](#usecollectiononcequery-options)
1719
- [useCollectionData](#usecollectiondatatref-idfield)

storage/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
1-
# Cloud Storage
1+
# React Firebase Hooks - Cloud Storage
22

33
React Firebase Hooks provides convenience listeners for files stored within
44
Firebase Cloud Storage. The hooks wrap around the `firebase.storage().ref().getDownloadURL()` method.
55

66
In addition to returning the download URL, the hooks provide an `error` and `loading` property
77
to give a complete lifecycle for loading from Cloud Storage.
88

9+
List of Cloud Storage hooks:
10+
911
- [useDownloadURL](#usedownloadurlref)
1012

1113
### `useDownloadURL(ref)`

0 commit comments

Comments
 (0)