Skip to content

Commit adcff71

Browse files
committed
updated docs
1 parent 9046d40 commit adcff71

File tree

1 file changed

+22
-16
lines changed

1 file changed

+22
-16
lines changed

docs/options/README.md

Lines changed: 22 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,13 @@
11
# Options
22

3-
## useOnly
4-
5-
By default, all supported Firebase products are loaded. If you only wish to load certain products (recommended!), add the `useOnly` option.
3+
## config[environment] <Badge text="REQUIRED" type="tip"/>
64

7-
- type: `Array<string>`
8-
- default: `['auth','firestore','functions','storage','realtimeDb', 'messaging', 'performance', 'analytics', 'remoteConfig']`
9-
- required: `false`
10-
11-
## config[environment]
12-
13-
Your firebase config snippet. You can retrieve this information from your Firebase project's overview page:
5+
Your firebase config snippet and other Firebase specific configs. You can retrieve this information from your Firebase project's overview page:
146

157
`https://console.firebase.google.com/project/<your-project-id>/overview`
168

9+
Must be defined **per environment** existing in NODE_ENV, or custom environment specified in the [customEnv](/options/#customenv) option below.
10+
1711
```js
1812
{
1913
// REQUIRED: Official config for firebase.initializeApp(config):
@@ -32,6 +26,18 @@ Your firebase config snippet. You can retrieve this information from your Fireba
3226

3327
`config.production` gets loaded when `NODE_ENV === 'production', same applies to 'development' and any other values that you set in NODE_ENV.
3428

29+
## useOnly
30+
31+
By default, all supported Firebase products are loaded. If you only wish to load certain products (recommended!), add the `useOnly` option.
32+
33+
- type: `Array<string>`
34+
- default: `['auth','firestore','functions','storage','realtimeDb', 'messaging', 'performance', 'analytics', 'remoteConfig']`
35+
- required: `false`
36+
37+
::: tip RECOMMENDED
38+
We highly recommend you to use this option to reduce your bundle size.
39+
:::
40+
3541
## customEnv
3642

3743
By default, the Firebase config will be chosen based on the NODE_ENV environment variable.
@@ -108,10 +114,10 @@ You can customize how remoteConfig should be initialized with the following sett
108114
}
109115
```
110116

111-
## initAuth (EXPERIMENTAL)
117+
## initAuth <Badge text="EXPERIMENTAL" type="warn"/>
112118

113-
::: warning
114-
EXPERIMENTAL FEATURE: This feature has not been fully tested for all cases, use it with care. It might get changed completely in future updates. Please only use it for test purposes. If you have any issues with the initAuth feature please let us know [here](https://github.com/lupas/nuxt-fire/issues/53) and help us improve it.
119+
::: warning <Badge text="EXPERIMENTAL FEATURE" type="warn"/>
120+
This feature is experimental and has not been fully tested for all cases. Use it with care and don't use it in production environemnts. It might get changed completely in future updates. If you have any issues or questions for this feature please feel free to create an issue [here](https://github.com/lupas/nuxt-fire/issues) to help us improve it.
115121
:::
116122

117123
Set up SSR-ready onAuthStateChanged() without any effort.
@@ -135,10 +141,10 @@ When onAuthStateChanged() gets triggered by Firebase, the mutations/actions defi
135141
**onErrorMutation & onErrorAction:**
136142
(error)
137143

138-
## initMessaging (EXPERIMENTAL)
144+
## initMessaging <Badge text="EXPERIMENTAL" type="warn"/>
139145

140-
::: warning
141-
EXPERIMENTAL FEATURE: This feature has not been fully tested for all cases, use it with care. It might get changed completely in future updates. Please only use it for test purposes. If you have any issues with the initAuth feature please let us know [here](https://github.com/lupas/nuxt-fire/issues) and help us improve it.
146+
::: warning <Badge text="EXPERIMENTAL FEATURE" type="warn"/>
147+
This feature is experimental and has not been fully tested for all cases. Use it with care and don't use it in production environemnts. It might get changed completely in future updates. If you have any issues or questions for this feature please feel free to create an issue [here](https://github.com/lupas/nuxt-fire/issues) to help us improve it.
142148
:::
143149

144150
Set up Firebase Messaging without any boilerplate code.

0 commit comments

Comments
 (0)