rnfirebase.io

# React Native Firebase

A well-tested feature-rich modular Firebase implementation for React Native. Supports both iOS & Android platforms for all Firebase services.

## Docs

- [React Native Firebase](https://rnfirebase.io/): Getting started: React Native CLI and Expo installation, native config files, FirebaseApp.configure(), iOS SPM setup, Expo config plugins, native SDK version overrides, Android executor tuning, and initializeApp for web and other platforms.
- [About](https://rnfirebase.io/about): This history and future of React Native Firebase
- [FAQs and Tips](https://rnfirebase.io/faqs-and-tips): Troubleshooting: react-native-firebase vs firebase-js-sdk, New Architecture compatibility, CI build hangs, Analytics 'items' parameter, InternalFirebaseAuth.FIREBASE_AUTH_API errors, Crashlytics iOS crash testing under the Xcode debugger...
- [iOS SPM Support](https://rnfirebase.io/ios-spm): Swift Package Manager support for Firebase Apple SDK dependencies (required for Firebase Apple SDK 13+): requirements, dynamic linkage, Expo configuration, the rnfirebase_* Podfile fallbacks, sharing FirebaseCore with other native pods, ...
- [Migrating to v6](https://rnfirebase.io/migrating-to-v6): Migrate from react-native-firebase v5 to v6: install the scoped @react-native-firebase/app plus per-service packages, with breaking changes for AdMob, Analytics, Crashlytics, Firestore, Dynamic Links, Functions, In-App Messaging, Instanc...
- [Migrating to v22](https://rnfirebase.io/migrating-to-v22): Migrate to v22: switch from the namespaced API to modular functions, silence deprecation warnings with RNFB_SILENCE_MODULAR_DEPRECATION_WARNINGS, enforce the change with RNFB_MODULAR_DEPRECATION_STRICT_MODE, and a Firestore modular query...
- [Migrating to v23](https://rnfirebase.io/migrating-to-v23): Migrate to v23: isCrashlyticsCollectionEnabled becomes a property, MultiFactorUser.enrolledFactors rename, an Analytics measurementId change, removal of Firebase Dynamic Links, and minSdk/iOS deployment target/Xcode version bumps.
- [Migrating to v24](https://rnfirebase.io/migrating-to-v24): Migrate to v24: Firestore TypeScript generic types for DocumentReference/Query/CollectionReference with separate type exports, and Cloud Functions becoming a TurboModule that requires React Native's New Architecture.
- [Migrating to v25](https://rnfirebase.io/migrating-to-v25): Migrate to v25: package-scoped modular type and export renames across Cloud Storage, Realtime Database, Remote Config, Performance Monitoring, Installations, App Check and Auth (deprecated provider helpers, multi-factor and phone auth si...
- [Migrating to v26](https://rnfirebase.io/migrating-to-v26): Migrate to v26: namespaced API removal from App, ML, In-App Messaging, Installations, Cloud Messaging, App Distribution and Cloud Functions, plus the New Architecture requirement and iOS APNs ARM64 Simulator Promise-rejection changes.
- [Migrating to v27](https://rnfirebase.io/migrating-to-v27): Migrate to React Native Firebase v27 - Firebase Android BoM 35, Apple SDK 13 (SPM-only), JS SDK 13, platform floors, AI API removals, messaging corrections, and ML package removal.
- [Platforms](https://rnfirebase.io/platforms): Supported platforms and minimum OS/JDK versions, with the firebase-js-sdk fallback for web/macOS/Windows and its limitations for Auth, Database, Firestore and Storage.
- [Release notes](https://rnfirebase.io/releases): Where release notes live: the aggregated CHANGELOG.md from v10.0.0 onward, per-package CHANGELOG.md links for v6.5.0-v10.0.0, and this page's own table for v6.0.0-v6.4.0.
- [TypeScript](https://rnfirebase.io/typescript): Modular API import patterns for TypeScript, where the generated type definitions live, and the compare:types process used for Auth.
- [AI Logic](https://rnfirebase.io/ai/usage): Firebase AI Logic: getAI backends, getGenerativeModel text and multi-modal generation, Schema structured output, chat, function calling, token counting, video, audio, and PDF analysis, image generation, grounding, request options, AIErro...
- [Screen Tracking](https://rnfirebase.io/analytics/screen-tracking): Track Analytics screen views with logScreenView() and ScreenViewParameters via React Navigation or React Native Navigation listeners.
- [Analytics](https://rnfirebase.io/analytics/usage): Analytics: getAnalytics/logEvent, predefined log* helpers and EventParameters types, setUserId/setUserProperties, setDefaultEventParameters, consent and collection toggles, app/session IDs, screen tracking, IDFA opt-out, on-device conver...
- [Firebase JSON Config](https://rnfirebase.io/app/json-config): Configure @react-native-firebase modules via firebase.json in the project root: key reference, file lookup and parse behavior, schema-driven editor IntelliSense, and runtime jsonGetAll().
- [Core / App](https://rnfirebase.io/app/usage): Core App module: default and secondary Firebase apps, logging, Async Storage wiring, native meta/preferences helpers, platform support, and New Architecture requirements.
- [Utils](https://rnfirebase.io/app/utils): App module utilities via getUtils() and FilePath: device directory constants, isRunningInTestLab() Test Lab detection, appVersion, and Android Play Services availability checks.
- [App Check](https://rnfirebase.io/app-check/usage): App Check: initializeAppCheck with ReactNativeFirebaseAppCheckProvider, getToken/getLimitedUseToken, setTokenAutoRefreshEnabled, onTokenChanged, SDK_VERSION, debug tokens, and the app_check_token_auto_refresh firebase.json flag.
- [App Distribution](https://rnfirebase.io/app-distribution/usage): App Distribution: getAppDistribution, isTesterSignedIn, signInTester, checkForUpdate, signOutTester, SDK_VERSION, and AppDistributionRelease fields for iOS in-app new-build alerts. Android JS alerts are not supported.
- [Email Link Authentication](https://rnfirebase.io/auth/email-link-auth): Passwordless email-link sign-in: Android App Links/iOS Universal Links setup, ActionCodeSettings, sendSignInLinkToEmail(), isSignInWithEmailLink(), signInWithEmailLink(), EmailAuthProvider.credentialWithLink() for linking/re-authenticati...
- [Multi-factor Auth](https://rnfirebase.io/auth/multi-factor-auth): TOTP and phone multi-factor authentication: enrollment and sign-in flows using multiFactor() (MultiFactor / MultiFactorUser), TotpMultiFactorGenerator (generateSecret, assertionForEnrollment, assertionForSignIn), TotpSecret (secretKey, g...
- [OpenID Connect Authentication](https://rnfirebase.io/auth/oidc-auth): OpenID Connect sign-in: obtaining ID tokens with react-native-app-auth and exchanging them via OAuthProvider and signInWithCredential.
- [Phone Authentication](https://rnfirebase.io/auth/phone-auth): Phone number authentication: iOS/Android reCAPTCHA and Play Integrity setup, Expo config, signInWithPhoneNumber(), verifyPhoneNumber() with PhoneAuthListener / PhoneAuthState / PhoneAuthSnapshot / PhoneAuthError, test phone numbers, link...
- [Social Authentication](https://rnfirebase.io/auth/social-auth): Federated sign-in with Apple (OAuthProvider, AppleFullPersonName, revokeToken), Facebook, Google, GitHub, Microsoft and Twitter, signInWithPopup / signInWithRedirect / linkWithPopup / linkWithRedirect / reauthenticateWithPopup / reauthen...
- [Authentication](https://rnfirebase.io/auth/usage): Core Authentication: getAuth(), initializeAuth(), connectAuthEmulator(), listeners (onAuthStateChanged, onIdTokenChanged, beforeAuthStateChanged), anonymous and email/password sign-in, custom tokens, validatePassword(), fetchSignInMethod...
- [Crashlytics - Android Setup](https://rnfirebase.io/crashlytics/android-setup): Additional Android Crashlytics setup: the Gradle plugin dependency and optional NDK crash reporting.
- [Crashlytics in the Firebase Console](https://rnfirebase.io/crashlytics/crash-reports): Reviewing Crashlytics reports in the Firebase console: issue grouping, logs and keys on a report, closing issues, and ANR collection on Android.
- [Crashlytics](https://rnfirebase.io/crashlytics/usage): Crashlytics: getCrashlytics, log, setUserId/setAttribute(s), recordError, crash, collection toggles, unsent-report helpers, SDK_VERSION, and firebase.json flags for auto-collection, debug mode and JS exception handling.
- [Offline Support](https://rnfirebase.io/database/offline-support): Realtime Database offline persistence: setPersistenceEnabled(), goOffline()/goOnline(), setPersistenceCacheSizeBytes(), keepSynced(), and getServerTime().
- [Presence Detection](https://rnfirebase.io/database/presence-detection): Build a presence detection system with Realtime Database: .info/connected, onDisconnect() (including cancel()), serverTimestamp() last-online stamps, .info/serverTimeOffset, and a multi-device presence sample.
- [Realtime Database](https://rnfirebase.io/database/usage): Realtime Database: getDatabase(), connectDatabaseEmulator(), ref()/refFromURL()/child(), reads (get, onValue with onlyOnce, child listeners), queries and sort-order rules, writes (set, update fan-out, push, remove, priorities), runTransa...
- [Cloud Firestore Emulator](https://rnfirebase.io/firestore/emulator): Connect to and test against the Cloud Firestore emulator for local development.
- [Pagination](https://rnfirebase.io/firestore/pagination): Paginate a Firestore query using orderBy(), limit() and startAfter() query constraints.
- [Pipelines](https://rnfirebase.io/firestore/pipelines): Firestore pipeline queries overview: stages, sources, Firestore Enterprise/cloud-execution requirements, basic usage, and expression helpers like findNearest().
- [Cloud Firestore](https://rnfirebase.io/firestore/usage): Cloud Firestore API guide: getFirestore/initializeFirestore settings, emulator, getDoc/getDocs (cache/server), onSnapshot options and error handling, queries (where/and/or/Filter, collectionGroup, documentId, FieldPath, cursors, limitToL...
- [Usage with FlatLists](https://rnfirebase.io/firestore/usage-with-flatlists): Render a Firestore collection in a React Native FlatList: subscribe with onSnapshot(collection(db, ...)), map QuerySnapshot documents into a keyed array, and update the list in realtime.
- [Cloud Functions](https://rnfirebase.io/functions/usage): Cloud Functions: getFunctions, connectFunctionsEmulator, httpsCallable with timeout and limitedUseAppCheckTokens options, httpsCallableFromUrl, callable.stream(), HttpsError / FunctionsError, HttpsErrorCode, SDK_VERSION, and region targe...
- [Writing & Deploying Cloud Functions](https://rnfirebase.io/functions/writing-deploying-functions): Write and deploy callable Cloud Functions for React Native Firebase: firebase-tools setup, onCall functions, request data and auth, streaming with sendChunk, HttpsError, App Check enforcement, emulator testing, and deployment.
- [In-App Messaging](https://rnfirebase.io/in-app-messaging/usage): In-App Messaging: getInAppMessaging, suppress display, automatic data collection, triggerEvent, SDK_VERSION, Analytics peer, and firebase.json auto-collection. Not Cloud Messaging.
- [Installations](https://rnfirebase.io/installations/usage): Installations: getInstallations, getId, getToken, deleteInstallations, onIdChange (unsupported), and SDK_VERSION for Firebase installation IDs and auth tokens.
- [iOS Notification Images](https://rnfirebase.io/messaging/ios-notification-images): Create a Notification Service Extension target in Xcode and call the Firebase extension helper to show images in iOS push notifications. The CocoaPods Firebase recipe for the extension target is not supported on Firebase Apple SDK 13+ (S...
- [iOS Permissions](https://rnfirebase.io/messaging/ios-permissions): iOS notification permissions with react-native-permissions: requestNotifications(), checkNotifications(), permission options, provisional authorization, and the in-app notification settings button.
- [Migrating to Installation ID](https://rnfirebase.io/messaging/migrating-to-installation-id): Migrate Cloud Messaging from FCM registration tokens to Firebase Installation ID (FID) registration.
- [Notifications](https://rnfirebase.io/messaging/notifications): Display and handle FCM notifications sent via the Firebase console, Admin SDKs or REST API: getInitialNotification(), onNotificationOpenedApp(), and device registration with register()/onRegistered() and the deprecated getToken().
- [Server Integration](https://rnfirebase.io/messaging/server-integration): Integrate FCM with a backend server: register()/onRegistered() device registration, saving Installation IDs to a database, sending to devices or topics with Admin SDKs, and signing out users with unregister(), plus the deprecated getToke...
- [Cloud Messaging](https://rnfirebase.io/messaging/usage): Cloud Messaging: getMessaging/isSupported, Installation ID registration (register/unregister/onRegistered/onUnregistered), deprecated FCM tokens (getToken/deleteToken/onTokenRefresh), permissions, foreground/background handlers, topics, ...
- [Performance Monitoring with Axios](https://rnfirebase.io/perf/axios-integration): Wire Axios request/response interceptors to Firebase Performance Monitoring's httpMetric(): start the metric on request, then set the response code/content-type and stop it on success or error.
- [Performance Monitoring with KY](https://rnfirebase.io/perf/ky-integration): Wrap the fetch function that KY calls so every request attempt is measured with Firebase Performance Monitoring's httpMetric().
- [Performance Monitoring](https://rnfirebase.io/perf/usage): Performance Monitoring: getPerformance/initializePerformance, trace() custom traces, httpMetric() HTTP metrics, newScreenTrace/startScreenTrace, collection toggles, SDK_VERSION, and the perf_auto_collection_enabled and perf_collection_de...
- [Phone Number Verification](https://rnfirebase.io/phone-number-verification/usage): Android-only carrier phone verification without SMS: enableTestSession, getVerificationSupportInfo, getVerifiedPhoneNumber, Digital Credential helpers, PnvErrorCode, and related types.
- [v6.0.0 Release](https://rnfirebase.io/releases/v6.0.0): v6.0.0: split react-native-firebase into per-service @react-native-firebase/* packages, added firebase.json configuration, and rewrote App, AdMob, Analytics, Crashlytics, Firestore, Dynamic Links, Messaging, Remote Config and Storage, pl...
- [v6.0.1 Release](https://rnfirebase.io/releases/v6.0.1): v6.0.1 bug fixes: Auth verifyPhoneNumber casting/iOS crash, a Crashlytics setUserId crash with auto_collection disabled, Firestore settings/FieldPath/query-chaining fixes, and a Vision file:// path fix.
- [v6.0.2 Release](https://rnfirebase.io/releases/v6.0.2): v6.0.2 bug fixes: iOS native listener cleanup on reload, Analytics TS type corrections, Auth NativeFirebaseError stack traces and iOS subscription cleanup, a Firestore id-cursor fix, and ML Vision nil-check fixes.
- [v6.0.3 Release](https://rnfirebase.io/releases/v6.0.3): v6.0.3 bug fixes: an iOS Realtime Database reload crash, Firestore QuerySnapshot.forEach TypeScript types, and an iOS Storage ph:// Photos asset upload fix.
- [v6.1.0 Release](https://rnfirebase.io/releases/v6.1.0): v6.1.0: Firestore array-contains/array-contains-any/in queries, a Remote Config minimumFetchInterval setting, Firebase Android BOM v28.0.3 and iOS SDK v6.13.0, plus AdMob, Auth, Crashlytics, Database, Firestore, Messaging and Storage bug...
- [v6.2.0 Release](https://rnfirebase.io/releases/v6.2.0): v6.2.0: Sign in with Apple support for Firebase Authentication on iOS via the new react-native-apple-authentication library, ahead of Apple's App Store Sign-In-with-Apple requirement.
- [v6.3.0 Release](https://rnfirebase.io/releases/v6.3.0): v6.3.0: adds iOS userAccessGroup support to the auth module and a Firestore QueryDocumentSnapshot interface, plus AdMob, Analytics, Auth, Crashlytics, Database and Firestore bug fixes.
- [v6.4.0](https://rnfirebase.io/releases/v6.4.0): v6.4.0: Messaging-focused release adding onNotificationOpenedApp()/getInitialNotification(), iOS setBackgroundMessageHandler() support, an upgraded iOS permissions API, and an iOS static-frameworks Podfile option, plus Analytics, Auth, D...
- [Remote Config](https://rnfirebase.io/remote-config/usage): Remote Config: getRemoteConfig, ensureInitialized, isSupported, defaultConfig, setDefaultsFromResource, fetchAndActivate/fetchConfig/activate, getValue/getBoolean/getNumber/getString/getAll, ValueSource, LastFetchStatus, onConfigUpdate, ...
- [Cloud Storage](https://rnfirebase.io/storage/usage): Cloud Storage: getStorage/ref, connectStorageEmulator, uploadString/uploadBytesResumable/putFile, Task progress with pause/resume/cancel and TaskState, getDownloadURL/writeToFile, getMetadata/updateMetadata, list/listAll, deleteObject, r...
- [VertexAI](https://rnfirebase.io/vertexai/usage): Deprecated @react-native-firebase/vertexai pointer: getVertexAI() returns an AI instance. Migrate to getAI() with AgentPlatformBackend from @react-native-firebase/ai.
- [currentDocument](https://rnfirebase.io/firestore/pipelines/current-document): Firestore pipelines currentDocument() expression helper: reference the document being processed, typically inside a select() stage.
- [ifNull](https://rnfirebase.io/firestore/pipelines/if-null): Firestore pipelines ifNull() expression helper: provide a fallback value when a field is null or absent, contrasted with ifAbsent().
- [Pipeline SDK compatibility](https://rnfirebase.io/firestore/pipelines/sdk-compatibility): Compare React Native Firebase's Firestore pipelines API to firebase-js-sdk: supported features, known gaps, and platform-specific execution notes.
- [subcollection](https://rnfirebase.io/firestore/pipelines/subcollection): Firestore pipelines subcollection() source helper: target a subcollection, typically paired with aggregate() and toScalarExpression().
- [switchOn](https://rnfirebase.io/firestore/pipelines/switch-on): Firestore pipelines switchOn() expression helper for switch-statement-style conditional logic.
- [timestampDiff](https://rnfirebase.io/firestore/pipelines/timestamp-diff): Firestore pipelines timestampDiff() expression helper: calculate the difference between two timestamps in a chosen unit.
- [timestampExtract](https://rnfirebase.io/firestore/pipelines/timestamp-extract): Firestore pipelines timestampExtract() expression helper: pull a calendar part (year, month, day) out of a timestamp.
- [iOS Messaging Setup](https://rnfirebase.io/messaging/usage/ios-setup): iOS Cloud Messaging setup in Xcode: enabling Push Notifications and Background Modes, and linking an APNs key/app identifier/provisioning profile to FCM.
- [Messaging with XMPP](https://rnfirebase.io/messaging/usage/messaging-with-xmpp): Device-to-device FCM messaging over an XMPP connection using node-xcs and the Firebase Admin SDK for sending.