React Native Firebase

https://rnfirebase.io/
Admin
React Native Firebase is the officially recommended collection of packages that brings React Native...
Tokens:163,907
Snippets:1,717
Trust Score:9.6
Update:44 minutes ago
Show doc for...
Tokens:
Raw
### Install & setup the app module

Source: https://rnfirebase.io/analytics/usage

Install & setup the app module

```bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the analytics module
yarn add @react-native-firebase/analytics

# If you're developing your app using iOS, run this command
cd ios/ && pod install
```

--------------------------------

### Run the Firestore emulator

Source: https://rnfirebase.io/firestore/emulator

Install the Firebase CLI and start the Firestore emulator. The emulator will also be installed if this is your first time running the command.

```bash
// install the Firebase CLI which will run the emulator
curl -sL firebase.tools | bash

// run this command to start the emulator, it will also install it if this is your first time running the command
firebase emulators:start --only firestore
```

--------------------------------

### Install and setup the app module

Source: https://rnfirebase.io/storage/usage

Install the core Firebase app module using yarn. This is a prerequisite for the storage module.

```bash
# Install & setup the app module
yarn add @react-native-firebase/app
```

--------------------------------

### Full phone multi-factor sign-in flow example

Source: https://rnfirebase.io/auth/multi-factor-auth

Complete example combining all steps: sign in, catch multi-factor error, get resolver, check hints, send verification code, and resolve sign-in with assertion.

```js
import {
  PhoneAuthProvider,
  PhoneMultiFactorGenerator,
  getAuth,
  signInWithEmailAndPassword,
  getMultiFactorResolver,
} from '@react-native-firebase/auth';

signInWithEmailAndPassword(getAuth(), email, password)
  .then(() => {
    // User has not enrolled a second factor
  })
  .catch(error => {
    const { code } = error;
    // Make sure to check if multi factor authentication is required
    if (code === 'auth/multi-factor-auth-required') {
      const resolver = getMultiFactorResolver(getAuth(), error);

      if (resolver.hints.length > 1) {
        // Use resolver.hints to display a list of second factors to the user
      }

      if (resolver.hints[0].factorId === PhoneMultiFactorGenerator.FACTOR_ID) {
        const hint = resolver.hints[0];

        new PhoneAuthProvider(getAuth())
          .verifyPhoneNumber({ multiFactorHint: hint, session: resolver.session }) // triggers the message to the user
          .then(verificationId => setVerificationId(verificationId));

        // Request verificationCode from user

        const credential = PhoneAuthProvider.credential(verificationId, verificationCode);

        const multiFactorAssertion = PhoneMultiFactorGenerator.assertion(credential);

        resolver.resolveSignIn(multiFactorAssertion).then(userCredential => {
          // additionally onAuthStateChanged will be triggered as well
        });
      }
    }
  });
```

--------------------------------

### Initialize Performance Monitoring and start a trace (before v25)

Source: https://rnfirebase.io/migrating-to-v25

Previously, getPerformance() returned an instance with methods like newTrace. This example shows the old API for starting a trace.

```javascript
// Previously
import { getPerformance } from '@react-native-firebase/perf';

const perf = getPerformance();
const t = perf.newTrace('load_screen');
await t.start();
```

--------------------------------

### Initialize Performance Monitoring and start a trace (v25)

Source: https://rnfirebase.io/migrating-to-v25

Now, getPerformance() returns synchronously and trace is a standalone function. This example shows the new API for starting a trace.

```javascript
// Now
import { getPerformance, trace } from '@react-native-firebase/perf';

const perf = getPerformance();
const t = trace(perf, 'load_screen');
await t.start();
```

--------------------------------

### Get installation ID (before v25)

Source: https://rnfirebase.io/migrating-to-v25

Previously, getInstallations() returned an instance with methods like getId. This example shows the old API for retrieving the installation ID.

```javascript
// Previously
import { getInstallations } from '@react-native-firebase/installations';

const installations = getInstallations();
const id = await installations.getId();
```

--------------------------------

### Install and setup the authentication module

Source: https://rnfirebase.io/auth/usage

Installs the required @react-native-firebase/app and @react-native-firebase/auth packages, and runs pod install for iOS. Use this when setting up Firebase Authentication in a React Native project.

```bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the authentication module
yarn add @react-native-firebase/auth

# If you're developing your app using iOS, run this command
cd ios/ && pod install
```

--------------------------------

### Full example: Firestore pagination in React Native

Source: https://rnfirebase.io/firestore/pagination

Complete working example combining state setup, LoadData, and MakeUserData. Press the button to load pages of 3 users sorted by age.

```jsx
import React, { useState } from 'react';
import type { Node } from 'react';
import { Text, View, Button, Alert } from 'react-native';

import {
  collection,
  getDocs,
  getFirestore,
  limit,
  orderBy,
  query,
  startAfter,
} from '@react-native-firebase/firestore';

const db = getFirestore();
const usersRef = collection(db, 'Users');

const App: () => Node = () => {
  const [lastDocument, setLastDocument] = useState();
  const [userData, setUserData] = useState([]);

  function LoadData() {
    console.log('LOAD');
    const constraints = [orderBy('age')]; // sort the data
    if (lastDocument !== undefined) {
      constraints.push(startAfter(lastDocument)); // fetch data following the last document accessed
    }
    constraints.push(limit(3)); // limit to your page size, 3 is just an example

    getDocs(query(usersRef, ...constraints)).then(querySnapshot => {
      setLastDocument(querySnapshot.docs[querySnapshot.docs.length - 1]);
      MakeUserData(querySnapshot.docs);
    });
  }

  function MakeUserData(docs) {
    let templist = [];
    docs.forEach((doc, i) => {
      console.log(doc._data);
      let temp = (
        <View key={i} style={{ margin: 10 }}>
          <Text>{doc._data.name}</Text>
          <Text>{doc._data.age}</Text>
        </View>
      );
      templist.push(temp);
    });
    setUserData(templist);
  }

  return (
    <View>
      {userData}
      <Button
        onPress={() => {
          LoadData();
        }}
        title="Load Next"
      />
    </View>
  );
};

export default App;
```

--------------------------------

### Full Example

Source: https://rnfirebase.io/perf/ky-integration

A working example is provided below. Please adjust and extend according to your use case.

```js
import { getPerformance, httpMetric } from '@react-native-firebase/perf';
import ky from 'ky';

const getContentLength = headers => {
  const length = getHeader('Content-Length', headers);
  return length ? Number(length) : null;
};

const getHeader = (header, headers) => headers.get(header) || headers.get(header.toLowerCase());

const api = ky.create({
  // prevent circular dependency warning
  fetch: fetch,
  hooks: {
    beforeRequest: [
      async (request, options) => {
        const { url, method } = request;
        options.metric = httpMetric(getPerformance(), url, method);

        // add any extra metric attributes, if required
        // options.metric.putAttribute('userId', '12345678');
        // options.metric.setRequestPayloadSize(1234)

        options.metric.start();
      },
    ],

    afterResponse: [
      async (request, options, response) => {
        const { status, headers } = response;
        const { metric } = options;
        metric.setHttpResponseCode(status);
        metric.setResponseContentType(getHeader('Content-Type', headers));
        metric.setResponsePayloadSize(getContentLength(headers));
        metric.stop();
      },
    ],
  },
});

export default api;
```

--------------------------------

### Get installation ID (v25)

Source: https://rnfirebase.io/migrating-to-v25

Now, getInstallations() returns a modular object and getId is a standalone function. This example shows the new API for retrieving the installation ID.

```javascript
// Now
import { getInstallations, getId } from '@react-native-firebase/installations';

const installations = getInstallations();
const id = await getId(installations);
```

--------------------------------

### Authentication: Modular API example

Source: https://rnfirebase.io/migrating-to-v26

Now example showing the modular API for Authentication. Use getAuth() and root-level helper functions like signOut.

```js
// Now
import { getAuth, signOut } from '@react-native-firebase/auth';

const auth = getAuth();
await signOut(auth);
auth.currentUser;
```

--------------------------------

### Install and set up the in-app-messaging module

Source: https://rnfirebase.io/in-app-messaging/usage

Installs the required app and in-app-messaging modules via yarn, and runs pod install for iOS. Requires the app and analytics modules to be set up first.

```bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the in-app-messaging module
yarn add @react-native-firebase/in-app-messaging

# If you're developing your app using iOS, run this command
cd ios/ && pod install
```

--------------------------------

### SPM installation output

Source: https://rnfirebase.io/ios-spm

Example output from pod install showing that SPM is used for Firebase dependency resolution. The products listed are FirebaseCore and FirebaseInstallations.

```text
[react-native-firebase] RNFBApp: Using SPM for Firebase dependency resolution (products: FirebaseCore, FirebaseInstallations)
```

--------------------------------

### Install @faker-js/faker in functions directory

Source: https://rnfirebase.io/functions/writing-deploying-functions

Install the faker library to generate mock data for Cloud Functions. Run from the functions directory.

```bash
cd functions/
npm install @faker-js/faker
```

--------------------------------

### Install @react-native-firebase/perf and dependencies

Source: https://rnfirebase.io/perf/usage

Install the app module and performance monitoring module using yarn, then run pod install for iOS.

```bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the performance monitoring module
yarn add @react-native-firebase/perf

# If you're developing your app using iOS, run this command
cd ios/ && pod install
```

--------------------------------

### Create a Reference to a Database Node

Source: https://rnfirebase.io/database/usage

Use the `ref` function to create a reference to a specific node in the default Realtime Database. The example shows how to get a reference to the `/users/123` node.

```javascript
import { getDatabase, ref } from '@react-native-firebase/database';

const db = getDatabase();
const reference = ref(db, '/users/123');
```

--------------------------------

### Install iOS pods

Source: https://rnfirebase.io/storage/usage

If developing for iOS, run this command to install the native dependencies via CocoaPods.

```bash
# If you're developing your app using iOS, run this command
cd ios/ && pod install
```

--------------------------------

### Install Pods with repo update

Source: https://rnfirebase.io/auth/usage/installation/ios

Run this command to install the RNFBAuth Pod and update the local Pod repository. Use it after adding the Pod to your Podfile.

```bash
$ cd ios/
$ pod install --repo-update
```

--------------------------------

### Install the storage module

Source: https://rnfirebase.io/storage/usage

Install the Firebase Storage module using yarn. This provides the storage functionality.

```bash
# Install the storage module
yarn add @react-native-firebase/storage
```

--------------------------------

### Start query at a DocumentSnapshot

Source: https://rnfirebase.io/firestore/usage

Use a DocumentSnapshot with startAt to start the query at a specific document.

```javascript
import {
  collection,
  doc,
  getDoc,
  getDocs,
  getFirestore,
  orderBy,
  query,
  startAt,
} from '@react-native-firebase/firestore';

const db = getFirestore();
const userDocumentSnapshot = await getDoc(doc(collection(db, 'Users'), 'DEF'));

getDocs(query(collection(db, 'Users'), orderBy('age', 'desc'), startAt(userDocumentSnapshot))).then(
  querySnapshot => {
    /* ... */
  },
);
```

--------------------------------

### Install Authentication module

Source: https://rnfirebase.io/migrating-to-v6

Install the @react-native-firebase/auth package using yarn to add Authentication support.

```bash
yarn add @react-native-firebase/auth
```

--------------------------------

### App Distribution: Modular API example

Source: https://rnfirebase.io/migrating-to-v26

Now, use getAppDistribution() and the root-level helper isTesterSignedIn() to check if a tester is signed in. This example shows the modular pattern.

```javascript
// Now
import { getAppDistribution, isTesterSignedIn } from '@react-native-firebase/app-distribution';

const appDistribution = getAppDistribution();
await isTesterSignedIn(appDistribution);
```

--------------------------------

### Install Pods with repo update

Source: https://rnfirebase.io/analytics/usage/installation/ios

Run this command in the ios directory to install the RNFBAnalytics Pod and update the local Pod repository.

```bash
cd ios/
pod install --repo-update
```

--------------------------------

### Cloud Firestore: Modular API example

Source: https://rnfirebase.io/migrating-to-v26

Now example showing the modular API for Cloud Firestore. Use getFirestore() and root-level helper functions like collection, doc, setDoc, and serverTimestamp.

```js
// Now
import {
  getFirestore,
  collection,
  doc,
  setDoc,
  serverTimestamp,
} from '@react-native-firebase/firestore';

const db = getFirestore();
await setDoc(doc(collection(db, 'users'), 'alice'), {
  name: 'Alice',
  createdAt: serverTimestamp(),
});
```

--------------------------------

### Cloud Functions: Modular API example

Source: https://rnfirebase.io/migrating-to-v26

Now, use getFunctions() and the root-level helper httpsCallable() to call a cloud function. This example shows the modular pattern.

```javascript
// Now
import { getFunctions, httpsCallable } from '@react-native-firebase/functions';

const functions = getFunctions();
await httpsCallable(functions, 'myFn')({ foo: 'bar' });
```

--------------------------------

### Authentication: Removed namespaced API example

Source: https://rnfirebase.io/migrating-to-v26

Previously (removed) example showing the old namespaced API for Authentication. This code is no longer valid in v26.

```js
// Previously (removed)
import firebase from '@react-native-firebase/app';
import auth from '@react-native-firebase/auth';

firebase.auth().signOut();
auth().currentUser;
```

--------------------------------

### Basic switchOn example with orders collection

Source: https://rnfirebase.io/firestore/pipelines/switch-on

Use switchOn to map status codes to labels in a pipeline query on the orders collection. The example executes the pipeline and logs the statusLabel for each result.

```javascript
import { getFirestore } from '@react-native-firebase/firestore';
import {
  execute,
  field,
  constant,
  equal,
  switchOn,
} from '@react-native-firebase/firestore/pipelines';

const db = getFirestore('your-enterprise-database-id');

const snapshot = await execute(
  db
    .pipeline()
    .collection('orders')
    .select(
      switchOn(
        equal(field('status'), constant(1)),
        constant('Active'),
        equal(field('status'), constant(2)),
        constant('Pending'),
        constant('Unknown'),
      ).as('statusLabel'),
    ),
);

snapshot.results.forEach(row => {
  console.log(row.data().statusLabel);
});
```

--------------------------------

### Local endpoint URL for listProducts function

Source: https://rnfirebase.io/functions/writing-deploying-functions

Example output showing the local URL for the listProducts function after running the serve command.

```text
functions: listProducts: http://localhost:5000/rnfirebase-demo/us-central1/listProducts
```

--------------------------------

### Install Remote Config Module

Source: https://rnfirebase.io/remote-config/usage

Installs the required app and remote-config modules via yarn, and runs pod install for iOS. Requires prior setup of @react-native-firebase/app and @react-native-firebase/analytics.

```bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the remote-config module
yarn add @react-native-firebase/remote-config

# If you're developing your app using iOS, run this command
cd ios/ && pod install
```

--------------------------------

### Initialize a new Firebase project with functions

Source: https://rnfirebase.io/functions/writing-deploying-functions

Sets up a new Firebase project directory with Cloud Functions support. You will be prompted to choose a language (select JavaScript for this tutorial) and install dependencies.

```bash
firebase init functions
```

--------------------------------

### MFA-like Account Creation with Email/Password and Phone Verification

Source: https://rnfirebase.io/auth/phone-auth

This example demonstrates how to create a user with email and password, then verify their phone number and link it to the account. It uses the verifyPhoneNumber method and PhoneAuthProvider.credential to confirm the code. The flow includes handling authentication state changes and error cases.

```jsx
import React, { useState, useEffect } from 'react';
import { Button, TextInput, Text } from 'react-native';
import {
  PhoneAuthProvider,
  getAuth,
  onAuthStateChanged,
  createUserWithEmailAndPassword,
  verifyPhoneNumber,
} from '@react-native-firebase/auth';

export default function PhoneVerification() {
  // Set an initializing state whilst Firebase connects
  const [initializing, setInitializing] = useState(true);
  const [user, setUser] = useState();

  // If null, no SMS has been sent
  const [confirm, setConfirm] = useState(null);

  const [code, setCode] = useState('');

  // Handle user state changes
  function handleAuthStateChanged(user) {
    setUser(user);
    if (initializing) setInitializing(false);
  }

  useEffect(() => {
    const subscriber = onAuthStateChanged(getAuth(), handleAuthStateChanged);
    return subscriber; // unsubscribe on unmount
  }, []);

  // Handle create account button press
  async function createAccount() {
    try {
      await createUserWithEmailAndPassword(
        getAuth(),
        'jane.doe@example.com',
        'SuperSecretPassword!',
      );
      console.log('User account created & signed in!');
    } catch (error) {
      if (error.code === 'auth/email-already-in-use') {
        console.log('That email address is already in use!');
      }

      if (error.code === 'auth/invalid-email') {
        console.log('That email address is invalid!');
      }
      console.error(error);
    }
  }

  // Handle the verify phone button press
  async function handlePhoneNumberVerification(phoneNumber) {
    const confirmation = await verifyPhoneNumber(getAuth(), phoneNumber);
    setConfirm(confirmation);
  }

  // Handle confirm code button press
  async function confirmCode() {
    try {
      const credential = PhoneAuthProvider.credential(confirm.verificationId, code);
      let userData = await getAuth().currentUser.linkWithCredential(credential);
      setUser(userData.user);
    } catch (error) {
      if (error.code == 'auth/invalid-verification-code') {
        console.log('Invalid code.');
      } else {
        console.log('Account linking error');
      }
    }
  }

  if (initializing) return null;

  if (!user) {
    return <Button title="Login" onPress={() => createAccount()} />;
  } else if (!user.phoneNumber) {
    if (!confirm) {
      return (
        <Button
          title="Verify Phone Number"
          onPress={() =>
            handlePhoneNumberVerification('ENTER A VALID TESTING OR REAL PHONE NUMBER HERE')
          }
        />
      );
    }
    return (
      <>
        <TextInput value={code} onChangeText={text => setCode(text)} />
        <Button title="Confirm Code" onPress={() => confirmCode()} />
      </>
    );
  } else {
    return (
      <Text>
        Welcome! {user.phoneNumber} linked with {user.email}
      </Text>
    );
  }
}
```

--------------------------------

### List Files and Directories with Pagination

Source: https://rnfirebase.io/storage/usage

Use the list method to retrieve files and directories in a bucket reference. Results are paginated; pass the nextPageToken to fetch subsequent pages. The example recursively lists all items and logs their full paths.

```javascript
import { getStorage, ref } from '@react-native-firebase/storage';

function listFilesAndDirectories(reference, pageToken) {
  return reference.list({ pageToken }).then(result => {
    // Loop over each item
    result.items.forEach(ref => {
      console.log(ref.fullPath);
    });

    if (result.nextPageToken) {
      return listFilesAndDirectories(reference, result.nextPageToken);
    }

    return Promise.resolve();
  });
}

const reference = ref(getStorage(), 'images');

listFilesAndDirectories(reference).then(() => {
  console.log('Finished listing');
});
```

--------------------------------

### Using a secondary database

Source: https://rnfirebase.io/database/usage

If the default installed Firebase instance needs to address a different database within the same project, pass the database URL to `getDatabase`. For example:

```js
import { getDatabase, ref } from '@react-native-firebase/database';

const db = getDatabase(undefined, 'https://path-to-database.firebaseio.com');

ref(db);
```

--------------------------------

### Install the Custom Provider

Source: https://rnfirebase.io/app-check/usage/index

Initialize App Check with the configured custom provider using initializeAppCheck. Save the returned instance for later use.

```javascript
import { getApp } from '@react-native-firebase/app';
import { initializeAppCheck } from '@react-native-firebase/app-check';

const appCheck = await initializeAppCheck(getApp(), {
  provider: rnfbProvider,
  isTokenAutoRefreshEnabled: true,
});
```

--------------------------------

### Modular ML API usage with getML

Source: https://rnfirebase.io/migrating-to-v26

Use the modular getML function to access ML functionality. This example shows how to get the ML instance for the default app and a secondary app.

```javascript
// Now
import { getApp } from '@react-native-firebase/app';
import { getML } from '@react-native-firebase/ml';

getML().app.name; // default app
getML(getApp('secondaryFromNative')).app.name;
```

--------------------------------

### Custom verification with Digital Credentials

Source: https://rnfirebase.io/phone-number-verification/usage

Use the Digital Credential API flow for advanced phone number verification. The example shows getting a credential payload, exchanging the response for a verified phone number, and logging the result.

```javascript
import {
  getDigitalCredentialPayload,
  exchangeCredentialResponseForPhoneNumber,
} from '@react-native-firebase/phone-number-verification';

// Step 1: Get the credential payload
const payload = await getDigitalCredentialPayload('your-unique-nonce');

// Step 2: Use the payload with Android Credential Manager
// ... (pass payload to CredentialManager API)

// Step 3: Exchange the response for a verified phone number
const result = await exchangeCredentialResponseForPhoneNumber(credentialResponse);
console.log('Phone number:', result.phoneNumber);
console.log('Expires at:', new Date(result.expirationTimestamp * 1000));
```

--------------------------------

### Apply the plugin via the `/android/app/build.gradle` file (at the top):

Source: https://rnfirebase.io/app-distribution/usage

Apply the plugin via the `/android/app/build.gradle` file (at the top):

```groovy
apply plugin: 'com.android.application'
apply plugin: 'com.google.firebase.appdistribution'
```

--------------------------------

### Client-side messaging setup with @react-native-firebase/messaging

Source: https://rnfirebase.io/messaging/usage/messaging-with-xmpp

This example shows a common client-side implementation using @react-native-firebase/messaging to listen for messages, sent messages, and errors, and to send a message. However, due to limited permissions on the client, none of the listeners will acknowledge a message or error, so an additional server solution is required.

```javascript
import {
  getMessaging,
  onMessage,
  onMessageSent,
  onSendError,
  sendMessage,
} from '@react-native-firebase/messaging';

const messaging = getMessaging();

onMessage(messaging, message => {
  console.log('Received a message');
});

onMessageSent(messaging, message => {
  console.log('Sent a message');
});

onSendError(messaging, message => {
  console.log('Received an Error');
});

sendMessage(messaging, {
  data: {
    foo: 'bar',
  },
});
```

--------------------------------

### Install @react-native-firebase/app and @react-native-firebase/messaging

Source: https://rnfirebase.io/messaging/usage

Installs the required app and messaging modules using yarn. For iOS, run pod install after installation.

```bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the messaging module
yarn add @react-native-firebase/messaging

# If you're developing your app using iOS, run this command
cd ios/ && pod install
```

--------------------------------

### Install Firestore module with yarn and pod install

Source: https://rnfirebase.io/firestore/usage

Installs the required @react-native-firebase/app and @react-native-firebase/firestore packages, then runs pod install for iOS. Requires the app module to be set up first.

```bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the firestore module
yarn add @react-native-firebase/firestore

# If you're developing your app using iOS, run this command
cd ios/ && pod install
```

--------------------------------

### Generate mock products with faker and return in listProducts

Source: https://rnfirebase.io/functions/writing-deploying-functions

Initialize an array of 100 mock products using faker before the function is called, ensuring consistent results. The listProducts function returns the pre-generated products array.

```js
// functions/index.js
const functions = require('firebase-functions');
const { faker } = require('@faker-js/faker');

// Initialize products array
const products = [];

// Max number of products
const LIMIT = 100;

// Push a new product to the array
for (let i = 0; i &lt; LIMIT; i++) {
  products.push({
    name: faker.commerce.productName(),
    price: faker.commerce.price(),
  });
}

exports.listProducts = functions.https.onCall((data, context) => {
  return products;
});
```

--------------------------------

### Run local Cloud Functions server with npm run serve

Source: https://rnfirebase.io/functions/writing-deploying-functions

Start a local server to test Cloud Functions before deployment. Run from the functions directory.

```bash
cd functions/
npm run serve
```

--------------------------------

### Install Firestore Pipelines dependencies

Source: https://rnfirebase.io/firestore/pipelines

Install the required React Native Firebase packages and run pod install for iOS.

```bash
yarn add @react-native-firebase/app @react-native-firebase/firestore
cd ios && pod install
```

--------------------------------

### Install @react-native-firebase/phone-number-verification

Source: https://rnfirebase.io/phone-number-verification/usage

Install the phone-number-verification module after setting up the app module. This module is Android-only and requires the app module to be installed first.

```bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the phone-number-verification module
yarn add @react-native-firebase/phone-number-verification
```

--------------------------------

### Install @react-native-firebase/functions

Source: https://rnfirebase.io/functions/usage

Installs the app and functions modules and runs pod install for iOS. Requires the @react-native-firebase/app module to be set up first.

```bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the functions module
yarn add @react-native-firebase/functions

# If you're developing your app using iOS, run this command
cd ios/ && pod install
```

--------------------------------

### Foreground messages with modular API

Source: https://rnfirebase.io/migrating-to-v26

Now example showing the modular API for handling foreground messages. Use getMessaging() and onMessage() from the package root.

```js
// Now
import { getMessaging, onMessage } from '@react-native-firebase/messaging';

onMessage(getMessaging(), message => {
  console.log(message.data);
});
```

--------------------------------

### Start a chat session with history and stream responses

Source: https://rnfirebase.io/ai/usage

Use `model.startChat()` to create a chat session with initial history and generation config. Send messages with `chat.sendMessageStream()` and iterate over the stream to collect text. Retrieve the full conversation history with `chat.getHistory()`.

```js
import React from 'react';
import { AppRegistry, Button, Text, View } from 'react-native';
import { getApp } from '@react-native-firebase/app';
import { getAI, getGenerativeModel } from '@react-native-firebase/ai';

function App() {
  return (
    <View>
      <Button
        title="start chat session"
        onPress={async () => {
          const app = getApp();
          const ai = getAI(app);
          const model = getGenerativeModel(ai, { model: 'gemini-3.1-flash-lite' });

          const chat = model.startChat({
            history: [
              {
                role: 'user',
                parts: [{ text: 'Hello, I have 2 dogs in my house.' }],
              },
              {
                role: 'model',
                parts: [{ text: 'Great to meet you. What would you like to know?' }],
              },
            ],
            generationConfig: {
              maxOutputTokens: 100,
            },
          });

          const msg = 'How many paws are in my house?';
          const result = await chat.sendMessageStream(msg);

          let text = '';
          for await (const chunk of result.stream) {
            const chunkText = chunk.text();
            text += chunkText;
          }
          console.log(text);

          // When you want to see the history of the chat
          const history = await chat.getHistory();
          console.log(history);
        }}
      />
    </View>
  );
}
```

--------------------------------

### Install @react-native-firebase/app and @react-native-firebase/crashlytics

Source: https://rnfirebase.io/crashlytics/usage

Installs the required app and crashlytics modules using yarn, and runs pod install for iOS. Use this when setting up Crashlytics in a React Native project.

```bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the Crashlytics module
yarn add @react-native-firebase/crashlytics

# If you're developing your app using iOS, run this command
cd ios/ && pod install
```

--------------------------------

### Install @react-native-firebase/app-check

Source: https://rnfirebase.io/app-check/usage/index

Installs the required app module and the app-check module, then runs pod install for iOS. Use this when setting up App Check in a React Native Firebase project.

```bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the app-check module
yarn add @react-native-firebase/app-check

# If you're developing your app using iOS, run this command
cd ios/ && pod install
```

--------------------------------

### Switch to a secondary app instance by passing the instance

Source: https://rnfirebase.io/app/usage

Use this to pass the secondary app instance directly to the desired module.

```javascript
import { getApp, initializeApp } from '@react-native-firebase/app';
import { getAuth } from '@react-native-firebase/auth';

const secondaryApp = await initializeApp(credentials, config);

getAuth(secondaryApp).currentUser;
```

--------------------------------

### Custom screen trace example

Source: https://rnfirebase.io/perf/usage

Record a custom screen rendering trace (slow frames / frozen frames).

```jsx
import { getPerformance, startScreenTrace } from '@react-native-firebase/perf';

function screenTrace() {
  try {
    const screenTrace = startScreenTrace(getPerformance(), 'FooScreen');
    screenTrace.stop();
  } catch (e) {
    // rejects if iOS or (Android == 8 || Android == 8.1)
    // or if hardware acceleration is off
  }
}
```

--------------------------------

### Previously (removed) namespaced installations API

Source: https://rnfirebase.io/migrating-to-v26

Previously (removed) namespaced installations API

```js
// Previously (removed)
import firebase from '@react-native-firebase/app';
import installations from '@react-native-firebase/installations';

const id = await firebase.installations().getId();
// or
const id = await installations().getId();
```
Tokens:
Raw