Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs.json
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,11 @@
{ "title": "Migration Guide to v25", "href": "/migrating-to-v25" },
{ "title": "TypeScript", "href": "/typescript" },
{ "title": "Platforms", "href": "/platforms" },
{ "title": "FAQs and Tips", "href": "/faqs-and-tips" },
{
"title": "Release Notes",
"href": "https://github.com/invertase/react-native-firebase/blob/main/CHANGELOG.md"
},
{ "title": "FAQs and Tips", "href": "/faqs-and-tips" },
{ "title": "Feature Requests", "href": "https://invertase.canny.io/react-native-firebase" },
{
"title": "Contributing",
Expand Down
2 changes: 1 addition & 1 deletion docs/about.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ library is hard, yet rewarding work.

With the support from the community and Google, we're pleased to announce that starting in 2019, our very own
Mike Diarmid will be working full time on the library. With the lessons we've learnt, we'll be focusing on taking the
library to a new level. Read about it [here](https://invertase.io/blog/react-native-firebase-2019).
library to a new level. Read about it [here](https://medium.com/invertase/react-native-firebase-2019-7e334ca9bcc6).

The success and upkeep of the library would not be possible without the support and contributions from the community.
To date, we've had contributions from 114 members of the Open Source community on the repository to who we're very
Expand Down
2 changes: 1 addition & 1 deletion docs/ai/usage/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: AI Logic
description: Installation and getting started with Firebase AI Logic.
icon: //firebase.google.com/static/images/icons/firebase-ai-logic.svg
next: /analytics/usage
previous: /contributing
previous: /faqs-and-tips
---

# Installation
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/auth/phone-auth.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,13 @@ Ensure that all parts of step 1 and 2 from [the official firebase iOS phone auth

Phone auth requires app verification, and the automatic app verification process uses data-only firebase cloud messages to the app. Data-only cloud messaging only works on real devices where the app has background refresh enabled. If background refresh disabled, or if using the Simulator, app verification uses the fallback reCAPTCHA flow allowing you to check if it is configured correctly.

For reliable automated testing, you may want to disable both automatic and fallback reCAPTCHA app verification for your app. To do this, [you may disable app verification in AuthSettings](https://rnfirebase.io/reference/auth/authsettings#appVerificationDisabledForTesting) prior to calling any phone auth methods.
For reliable automated testing, you may want to disable both automatic and fallback reCAPTCHA app verification for your app. To do this, [you may disable app verification in AuthSettings](https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/AuthSettings.html#appVerificationDisabledForTesting) prior to calling any phone auth methods.

# Android Setup

Ensure that all parts of step 1 and 2 from [the official firebase Android phone auth docs](https://firebase.google.com/docs/auth/android/phone-auth#enable-phone-number-sign-in-for-your-firebase-project) have been followed.

To bypass Play Integrity for manual testing, you may [force reCAPTCHA to be used](https://rnfirebase.io/reference/auth/authsettings#appVerificationDisabledForTesting) prior to calling [`verifyPhoneNumber`](https://rnfirebase.io/reference/auth#verifyPhoneNumber).
To bypass Play Integrity for manual testing, you may [force reCAPTCHA to be used](https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/AuthSettings.html#appVerificationDisabledForTesting) prior to calling [`verifyPhoneNumber`](https://reference.rnfirebase.io/_react-native-firebase/auth/verifyPhoneNumber.html).

# Expo Setup

Expand All @@ -45,7 +45,7 @@ To use phone auth in an expo app, add the `@react-native-firebase/auth` config p

The `@react-native-firebase/auth` config plugin is not required for all auth providers, but it is required to use phone auth. The plugin [will set up reCAPTCHA](https://firebase.google.com/docs/auth/ios/phone-auth#set-up-recaptcha-verification) verification for you on iOS.

The recommendation is to use a [custom development client](https://docs.expo.dev/clients/getting-started/). For more info on using Expo with React Native Firebase, see our [Expo docs](/#expo).
The recommendation is to use a [custom development client](https://docs.expo.dev/develop/development-builds/introduction/#use-libraries-with-native-code-that-arent). For more info on using Expo with React Native Firebase, see our [Expo docs](/#installation-for-expo-projects).

# Sign-in

Expand Down
2 changes: 1 addition & 1 deletion docs/auth/usage/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ to the error. For a full list of error codes available, view the [Firebase docum

## Authenticate with backend server

The user's token should be used for authentication with your backend systems. The token is fetched with the [getIdToken](https://rnfirebase.io/reference/auth/user#getIdToken) method. As mentioned in the [Firebase documentation](https://firebase.google.com/docs/auth/web/manage-users#get_a_users_profile), the uid should not be used for authentication.
The user's token should be used for authentication with your backend systems. The token is fetched with the [getIdToken](https://reference.rnfirebase.io/_react-native-firebase/auth/FirebaseAuthTypes/User.html#getIdToken) method. As mentioned in the [Firebase documentation](https://firebase.google.com/docs/auth/web/manage-users#get_a_users_profile), the uid should not be used for authentication.

## Signing out

Expand Down
2 changes: 1 addition & 1 deletion docs/crashlytics/usage/installation/android.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ protected List<ReactPackage> getPackages() {

## 4. Additional Android Setup

Android requires additional steps in order to complete setup. View the [Android Setup](crashlytics/android-setup) documentation
Android requires additional steps in order to complete setup. View the [Android Setup](/crashlytics/android-setup) documentation
for more information.

## 5. Rebuild the project
Expand Down
2 changes: 1 addition & 1 deletion docs/database/presence-detection.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Presence Detection
description: Show a realtime list of online users with Realtime Database.
next: /firestore/usage
next: /in-app-messaging/usage
previous: /database/offline-support
---

Expand Down
6 changes: 3 additions & 3 deletions docs/faqs-and-tips.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: FAQs and Tips
description: Learn about top tips from and common problems faced by the React Native Firebase community.
next: /releases
previous: /migrating-to-v6
next: /ai/usage
previous: /platforms
---

Over the years, there’s been a lot of discussions on our [GitHub](https://github.com/invertase/react-native-firebase) and [Discord](https://invertase.link/discord). Many of them have been about common problems developers face when using our package, and some of them resulted in very good advice being given.
Expand Down Expand Up @@ -98,5 +98,5 @@ To view the complete detail for this solution, please refer to this page: [#5656
- Build processes are costly and complex, so caching is used a lot. As a result, certain changes that you make in your app can cause cache conflicts in subsequent builds. Deal with this via `npx react-native-clean-project`. This does solve a lot of problems.
- Try and isolate the problem with a template React Native Firebase app. This [bash script](https://github.com/mikehardy/rnfbdemo/blob/main/make-demo.sh) is particularly helpful in making an empty template app.
- Advice on supporting multiple environments (for example, dev, prod, maybe also staging, qa) for your React Native Firebase App: [#3504](https://github.com/invertase/react-native-firebase/issues/3504)
- Using [Fastlane for iOS deployment](https://docs.fastlane.tools/getting-started/ios) together with [RN Firebase Crashlytics](https://rnfirebase.io/crashlytics/usage) within CI has been observed to cause builds that hang indefinitely. Using `setup_ci(force: true)` before building the application may solve the issue.: [#3706](https://github.com/invertase/react-native-firebase/issues/3706)
- Using [Fastlane for iOS deployment](https://docs.fastlane.tools/getting-started/ios/setup/) together with [RN Firebase Crashlytics](https://rnfirebase.io/crashlytics/usage) within CI has been observed to cause builds that hang indefinitely. Using `setup_ci(force: true)` before building the application may solve the issue.: [#3706](https://github.com/invertase/react-native-firebase/issues/3706)
- Be careful if you are using a VPN, Google blocks many VPN IPs causing "unavailable" errors for various firebase API calls, and on an Android emulator it might completely mess up the network adapter causing network calls to never return, not only on firebase but on the entire emulated phone.
2 changes: 1 addition & 1 deletion docs/firestore/usage/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Cloud Firestore
description: Installation and getting started with Firestore.
icon: //firebase.google.com/static/images/products/icons/build_firestore.svg
next: /firestore/usage-with-flatlists
next: /firestore/emulator
previous: /auth/multi-factor-auth
---

Expand Down
2 changes: 1 addition & 1 deletion docs/firestore/usage/installation/android.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ protected List<ReactPackage> getPackages() {
````

In some scenarios, your Android build may fail with the `app:mergeDexDebug` error. This required that multidex is enabled
for your application. To learn more, read the [Enabling Multidex](/firestore/enabling-multidex) documentation.
for your application. To learn more, read the [Enabling Multidex](/enabling-multidex) documentation.

## 4. Rebuild your project

Expand Down
2 changes: 1 addition & 1 deletion docs/in-app-messaging/usage/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: In App Messaging
description: Installation and getting started with In App Messaging.
icon: //firebase.google.com/static/images/products/icons/run_in_app_messaging.svg
next: /installations/usage
previous: /functions/usage
previous: /database/presence-detection
---

# Installation
Expand Down
4 changes: 2 additions & 2 deletions docs/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ Additionally, current versions of firebase-ios-sdk have a minimum Xcode requirem

## Installation for Expo projects

Integration with Expo is possible when using a [development build](https://docs.expo.dev/workflow/overview/#development-builds). You can configure the project via [config plugins](https://docs.expo.io/guides/config-plugins/) or manually configure the native projects yourself (the "bare workflow").
Integration with Expo is possible when using a [development build](https://docs.expo.dev/workflow/overview/#development-builds). You can configure the project via [config plugins](https://docs.expo.dev/config-plugins/introduction/) or manually configure the native projects yourself (the "bare workflow").

_NOTE:_ React Native Firebase cannot be used in the pre-compiled [Expo Go app](https://docs.expo.dev/workflow/overview/#expo-go-an-optional-tool-for-learning) because React Native Firebase uses native code that is not compiled into Expo Go.

Expand Down Expand Up @@ -113,7 +113,7 @@ The `withoutAdIdSupport` option adds `$RNFirebaseAnalyticsWithoutAdIdSupport = t

### Local app compilation

If you are compiling your app locally, run [`npx expo prebuild --clean`](https://docs.expo.dev/workflow/prebuild/) to generate the native project directories. Then, follow the local app compilation steps described in [Local app development](https://docs.expo.dev/guides/local-app-development/) guide in Expo docs. If you prefer using a build service, refer to [EAS Build](https://docs.expo.dev/build/setup/).
If you are compiling your app locally, run [`npx expo prebuild --clean`](https://docs.expo.dev/workflow/continuous-native-generation/) to generate the native project directories. Then, follow the local app compilation steps described in [Local app development](https://docs.expo.dev/guides/local-app-development/) guide in Expo docs. If you prefer using a build service, refer to [EAS Build](https://docs.expo.dev/build/setup/).

Note: if you have already installed an Expo development build (using something like `npx expo run` after doing the `--prebuild` local development steps...) before installing react-native-firebase, then you must uninstall it first as it will not contain the react-native-firebase native modules and you will get errors with `RNFBAppModule not found` etc. If so, uninstall the previous development build, do a clean build using `npx expo prebuild --clean`, and then attempt `npx expo run:<platform>` again.

Expand Down
6 changes: 3 additions & 3 deletions docs/messaging/ios-notification-images.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ The following steps will guide you through how to add a new target to your appli
- Add a product name (use `ImageNotification` to follow along) and click **Finish**
- Enable the scheme by clicking **Activate**

![step-1](/assets/docs/messaging/ios-notification-images-step-1.gif)
![step-1](/assets/messaging/ios-notification-images-step-1.gif)

### Step 2 - Add target to the Podfile

Expand All @@ -40,7 +40,7 @@ end

- Install or update your pods using `pod install` from the `ios` folder

![step-2](/assets/docs/messaging/ios-notification-images-step-2.gif)
![step-2](/assets/messaging/ios-notification-images-step-2.gif)

### Step 3 - Use the extension helper (Objective-C)

Expand All @@ -67,7 +67,7 @@ At this point everything should still be running normally. This is the final ste
+ [[FIRMessaging extensionHelper] populateNotificationContent:self.bestAttemptContent withContentHandler:contentHandler];
```

![step-3](/assets/docs/messaging/ios-notification-images-step-3.gif)
![step-3](/assets/messaging/ios-notification-images-step-3.gif)

### Step 3 - Use the extension helper (Swift)

Expand Down
2 changes: 1 addition & 1 deletion docs/messaging/notifications.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Authorization: Bearer ya29.ElqKBGN2Ri_Uz...HnS_uNreA
}
```

To learn more about the REST API, view the [Firebase documentation](https://firebase.google.com/docs/cloud-messaging/send-message),
To learn more about the REST API, view the [Firebase documentation](https://firebase.google.com/docs/cloud-messaging/send/v1-api),
and select the "REST" tab under the code examples.

# Handling Interaction
Expand Down
2 changes: 1 addition & 1 deletion docs/messaging/server-integration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -337,4 +337,4 @@ admin
});
```

If you want to read more about building send requests with the Admin SDK check out [this link](https://firebase.google.com/docs/cloud-messaging/send-message).
If you want to read more about building send requests with the Admin SDK check out [this link](https://firebase.google.com/docs/cloud-messaging/send/v1-api).
2 changes: 1 addition & 1 deletion docs/messaging/usage/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -166,7 +166,7 @@ The device state and message contents determines which handler will be called:
until the background message handler is registered via setBackgroundMessageHandler, signaling the application's javascript
is loaded and ready to run.

To learn more about how to send these options in your message payload, view the Firebase documentation for your [FCM API implementation](https://firebase.google.com/docs/cloud-messaging/concept-options).
To learn more about how to send these options in your message payload, view the Firebase documentation for your [FCM API implementation](https://firebase.google.com/docs/cloud-messaging/customize-messages/setting-message-priority).

### Notifications

Expand Down
4 changes: 2 additions & 2 deletions docs/migrating-to-v22.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Migrating to v22
description: Migrate to React Native Firebase v22.
previous: /
next: /migrate-to-v23
next: /migrating-to-v23
---

# Switching off warning logs
Expand Down Expand Up @@ -93,4 +93,4 @@ You will find code snippets for "Web namespaced API" and "Web modular API" throu
- [App Check](https://firebase.google.com/docs/app-check/web/recaptcha-provider)
- [Analytics](https://firebase.google.com/docs/analytics/get-started)
- [Perf](https://firebase.google.com/docs/perf-mon/get-started-web)
- [Crashlytics](https://github.com/invertase/react-native-firebase/blob/main/packages/crashlytics/lib/modular/index.d.ts) (Crashlytics doesn't exist on Firebase web, this is a link to the type declarations which contains all methods available).
- [Crashlytics](https://github.com/invertase/react-native-firebase/blob/ae03f3f0be636fcd949965ee720a691f8582ef82/packages/crashlytics/lib/types/crashlytics.ts) (Crashlytics doesn't exist on Firebase web, this is a link to the type declarations which contains all methods available).
4 changes: 2 additions & 2 deletions docs/migrating-to-v23.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
---
title: Migrating to v23
description: Migrate to React Native Firebase v23.
previous: /migrate-to-v22
next: /migrate-to-v24
previous: /migrating-to-v22
next: /migrating-to-v24
---

# Firebase Crashlytics
Expand Down
2 changes: 1 addition & 1 deletion docs/migrating-to-v24.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Migrating to v24
description: Migrate to React Native Firebase v24.
previous: /migrate-to-v23
previous: /migrating-to-v23
next: /migrating-to-v25
---

Expand Down
7 changes: 3 additions & 4 deletions docs/migrating-to-v6.mdx
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
---
title: Migrating to v6
description: Migrate to React Native Firebase v6
next: /faqs-and-tips
previous: /releases
previous: /vertexai/usage
---

# Introduction
Expand All @@ -24,7 +23,7 @@ compatibility with the Firebase SDKs. We've also been working closely with the F
been approved before being released.

We have also ensured the release is compatible with some of the popular tooling in the React Native community, such as
[autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md) & [TypeScript](https://facebook.github.io/react-native/blog/2018/05/07/using-typescript-with-react-native).
[autolinking](https://github.com/react-native-community/cli/blob/master/docs/autolinking.md) & [TypeScript](https://reactnative.dev/docs/typescript).

Version 6 also brings support for previously unsupported modules such as [Firebase ML](https://firebase.google.com/docs/ml).

Expand Down Expand Up @@ -342,7 +341,7 @@ Please see the <Anchor href="/admob">AdMob</Anchor> documentation and update you

### Invites

The `invites` module has now been deprecated. Please see the official [Firebase documentation](https://firebase.google.com/docs/invites/deprecation)
The `invites` module has now been deprecated. Please see the official [Firebase Dynamic Links deprecation FAQ](https://firebase.google.com/support/dynamic-links-faq)
for more information.

The recommended approach for handling this deprecation is to use the Dynamic Links module.
Expand Down
2 changes: 1 addition & 1 deletion docs/ml/usage/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ cd ios/ && pod install
> **This package is mostly discontinued** since these APIs are no longer available in the latest Firebase SDKs.
> To call the Cloud Vision API from your app the recommended approach is using Firebase
> Authentication and Functions, which gives you a managed, serverless gateway to Google Cloud Vision APIs. For an example
> Functions project see the [vision-annotate-images](https://github.com/firebase/functions-samples/tree/main/vision-annotate-images) sample project.
> Functions project see the [vision-annotate-images](https://github.com/firebase/functions-samples/tree/3515b7f38a3c598cdb20152a263372e81719ecda/vision-annotate-images) sample project.

If you're using an older version of React Native without autolinking support, or wish to integrate into an existing project,
you can follow the manual installation steps for [iOS](/ml/usage/installation/ios) and [Android](/ml/usage/installation/android).
Expand Down
2 changes: 1 addition & 1 deletion docs/phone-number-verification/usage/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Phone Number Verification
description: Installation and getting started with Phone Number Verification.
icon: //static.invertase.io/assets/social/firebase-logo.png
next: /vertexai/usage
previous: /perf/usage
previous: /perf/ky-integration
---

# Installation
Expand Down
3 changes: 2 additions & 1 deletion docs/platforms.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
---
title: Platforms
description: Learn the platforms React Native Firebase SDK supports.
next: /release-notes
previous: /typescript
next: /faqs-and-tips
---

## Status
Expand Down
Loading
Loading