Skip to content

Commit 4549aff

Browse files
committed
Add list of hooks to each documentation page
1 parent b5ea17a commit 4549aff

File tree

4 files changed

+19
-0
lines changed

4 files changed

+19
-0
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+
- [useAuthState](#useauthstateauth)
6+
57
## `useAuthState(auth)`
68

79
Parameters:

database/README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,12 @@ 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+
- [useList](#uselistref)
10+
- [useListKeys](#uselistkeystref)
11+
- [useListVals](#uselistvalstref-keyfield)
12+
- [useObject](#useobjectref)
13+
- [useObjectVal](#useobjectvaltref)
14+
915
## `useList(ref)`
1016

1117
Parameters:

firestore/README.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@ 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+
- [useCollection](#usecollectionquery-options)
16+
- [useCollectionOnce](#usecollectiononcequery-options)
17+
- [useCollectionData](#usecollectiondatatref-idfield)
18+
- [useCollectionDataOnce](#usecollectiondataoncetref-idfield)
19+
- [useDocument](#usedocumentdocref)
20+
- [useDocumentOnce](#usedocumentoncedocref)
21+
- [useDocumentData](#usedocumentdatatref)
22+
- [useDocumentDataOnce](#usedocumentdataoncetref)
23+
1524
## `useCollection(query, options)`
1625

1726
Parameters:

storage/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Firebase Cloud Storage. The hooks wrap around the `firebase.storage().ref().getD
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+
- [useDownloadURL](#usedownloadurlref)
10+
911
## `useDownloadURL(ref)`
1012

1113
Parameters:

0 commit comments

Comments
 (0)