Skip to content

Commit 97b86bd

Browse files
committed
Tweak header sizes
1 parent 4549aff commit 97b86bd

File tree

4 files changed

+21
-21
lines changed

4 files changed

+21
-21
lines changed

auth/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ React Firebase Hooks provides a convenience listener for Firebase Auth's auth st
44

55
- [useAuthState](#useauthstateauth)
66

7-
## `useAuthState(auth)`
7+
### `useAuthState(auth)`
88

99
Parameters:
1010

@@ -16,7 +16,7 @@ Returns:
1616
- `initialising`: If the listener is still waiting for the user to be loaded
1717
- `user`: The `firebase.User`, or `null`, if no user is logged in
1818

19-
### Example
19+
#### Example
2020

2121
```js
2222
import { useAuthState } from 'react-firebase-hooks/auth';

database/README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ to give a complete lifecycle for loading and listening to the Realtime Database.
1212
- [useObject](#useobjectref)
1313
- [useObjectVal](#useobjectvaltref)
1414

15-
## `useList(ref)`
15+
### `useList(ref)`
1616

1717
Parameters:
1818

@@ -25,7 +25,7 @@ Returns:
2525
- `loading`: A `boolean` to indicate if the listener is still being loaded
2626
- `value`: A list of `firebase.database.DataSnapshot`
2727

28-
### Example
28+
#### Example
2929

3030
```js
3131
import { useList } from 'react-firebase-hooks/database';
@@ -54,7 +54,7 @@ const DatabaseList = () => {
5454
};
5555
```
5656

57-
## `useListKeys<T>(ref)`
57+
### `useListKeys<T>(ref)`
5858

5959
As above, but this hook returns a list of the `DataSnapshot.key` values, rather than the the
6060
`DataSnapshot`s themselves.
@@ -70,7 +70,7 @@ Returns:
7070
- `loading`: A `boolean` to indicate if the listener is still being loaded
7171
- `value`: A list of `firebase.database.DataSnapshot.key` values
7272

73-
## `useListVals<T>(ref, keyField)`
73+
### `useListVals<T>(ref, keyField)`
7474

7575
Similar to `useList`, but this hook returns a typed list of the `DataSnapshot.val()` values, rather than the the
7676
`DataSnapshot`s themselves.
@@ -87,7 +87,7 @@ Returns:
8787
- `loading`: A `boolean` to indicate if the listener is still being loaded
8888
- `value`: A list of `firebase.database.DataSnapshot.val()` values, combined with the optional key field
8989

90-
## `useObject(ref)`
90+
### `useObject(ref)`
9191

9292
Parameters:
9393

@@ -100,7 +100,7 @@ Returns:
100100
- `loading`: A `boolean` to indicate if the listener is still being loaded
101101
- `value`: A `firebase.database.DataSnapshot`
102102

103-
### Example
103+
#### Example
104104

105105
```js
106106
import { useObject } from 'react-firebase-hooks/database';
@@ -120,7 +120,7 @@ const DatabaseValue = () => {
120120
};
121121
```
122122

123-
## `useObjectVal<T>(ref)`
123+
### `useObjectVal<T>(ref)`
124124

125125
As above, but this hook returns the typed contents of `DataSnapshot.val()` rather than the
126126
`DataSnapshot` itself.

firestore/README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ There are 2 variants of each hook:
2121
- [useDocumentData](#usedocumentdatatref)
2222
- [useDocumentDataOnce](#usedocumentdataoncetref)
2323

24-
## `useCollection(query, options)`
24+
### `useCollection(query, options)`
2525

2626
Parameters:
2727

@@ -35,7 +35,7 @@ Returns:
3535
- `loading`: A `boolean` to indicate if the listener is still being loaded
3636
- `value`: A `firebase.firestore.QuerySnapshot`
3737

38-
### Example
38+
#### Example
3939

4040
```js
4141
import { useCollection } from 'react-firebase-hooks/firestore';
@@ -65,7 +65,7 @@ const FirestoreCollection = () => {
6565
};
6666
```
6767

68-
## `useCollectionOnce(query, options)`
68+
### `useCollectionOnce(query, options)`
6969

7070
Parameters:
7171

@@ -85,7 +85,7 @@ Import:
8585
import { useCollectionOnce } from 'react-firebase-hooks/firestore';
8686
```
8787

88-
## `useCollectionData<T>(ref, idField)`
88+
### `useCollectionData<T>(ref, idField)`
8989

9090
As `useCollection`, but this hook returns a typed list of the
9191
`QuerySnapshot.docs` values, rather than the the `QuerySnapshot` itself.
@@ -110,7 +110,7 @@ Import:
110110
import { useCollectionData } from 'react-firebase-hooks/firestore';
111111
```
112112

113-
## `useCollectionDataOnce<T>(ref, idField)`
113+
### `useCollectionDataOnce<T>(ref, idField)`
114114

115115
Parameters:
116116

@@ -132,7 +132,7 @@ Import:
132132
import { useCollectionDataOnce } from 'react-firebase-hooks/firestore';
133133
```
134134

135-
## `useDocument(docRef)`
135+
### `useDocument(docRef)`
136136

137137
Parameters:
138138

@@ -146,7 +146,7 @@ Returns:
146146
- `loading`: A `boolean` to indicate if the listener is still being loaded
147147
- `value`: A `firebase.firestore.DocumentSnapshot`
148148

149-
### Example
149+
#### Example
150150

151151
```js
152152
import { useDocument } from 'react-firebase-hooks/firestore';
@@ -167,7 +167,7 @@ const FirestoreDocument = () => {
167167
};
168168
```
169169

170-
## `useDocumentOnce(docRef)`
170+
### `useDocumentOnce(docRef)`
171171

172172
Parameters:
173173

@@ -187,7 +187,7 @@ Import:
187187
import { useDocumentOnce } from 'react-firebase-hooks/firestore';
188188
```
189189

190-
## `useDocumentData<T>(ref)`
190+
### `useDocumentData<T>(ref)`
191191

192192
As `useDocument`, but this hook returns the typed contents of
193193
`DocumentSnapshot.val()` rather than the `DocumentSnapshot` itself.
@@ -212,7 +212,7 @@ Import:
212212
import { useDocumentData } from 'react-firebase-hooks/firestore';
213213
```
214214

215-
## `useDocumentDataOnce<T>(ref)`
215+
### `useDocumentDataOnce<T>(ref)`
216216

217217
Parameters:
218218

storage/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ to give a complete lifecycle for loading from Cloud Storage.
88

99
- [useDownloadURL](#usedownloadurlref)
1010

11-
## `useDownloadURL(ref)`
11+
### `useDownloadURL(ref)`
1212

1313
Parameters:
1414

@@ -21,7 +21,7 @@ Returns:
2121
- `loading`: A `boolean` to indicate if the download URL is still being loaded
2222
- `value`: The download URL
2323

24-
### Example
24+
#### Example
2525

2626
```js
2727
import { useDownloadURL } from 'react-firebase-hooks/storage';

0 commit comments

Comments
 (0)