react-native-firebase/README.md

8.9 KiB


React Native Firebase

NPM downloads NPM version License Backers on Open Collective Sponsors on Open Collective Chat Follow on Twitter

Introduction

RNFirebase makes using Firebase with React Native simple. It is a light-weight layer sitting on-top of the native Firebase libraries for both iOS and Android which mirrors the Firebase Web SDK as closely as possible.

Although the Firebase Web SDK library will work with React Native, it is mainly built for the web.

RNFirebase provides a JavaScript bridge to the native Firebase SDKs for both iOS and Android therefore Firebase will run on the native thread, allowing the rest of your app to run on the JS thread. The Firebase Web SDK also runs on the JS thread, therefore potentially affecting the frame rate causing jank with animations, touch events etc.

The native SDKs also allow us to hook into device sdk's which are not possible with the web SDK, for example crash reporting, offline realtime database support, analytics and more!

All in all, RNFirebase provides much faster performance (~2x) over the web SDK and provides device sdk's not found in the web sdk (see the feature table below).


Supported Firebase Features

The Web SDK column indicates what modules/functionality from the Web SDK are usable within React Native.

'?' indicates partial support

Firebase Features v1.x.x v2.x.x v3.x.x v3.1.x v3.2.x Web SDK
AdMob
Analytics            
App Indexing          
Authentication
-- Phone Auth
Core ?
-- Multiple Apps
Cloud Firestore ?
Cloud Messaging (FCM) ?
Crashlytics          
Crash Reporting
Dynamic Links
Invites ? ?
Performance Monitoring
Realtime Database
-- Offline Persistence ?
-- Transactions
Remote Config
Storage ?

Supported versions - React Native / Firebase

The table below shows the supported versions of React Native and the Firebase SDKs for different versions of react-native-firebase

1.X.X 2.0.X 2.1.X / 2.2.X 3.0.X 3.1.X 3.2.X
React Native 0.36 - 0.39 0.40 - 0.46 0.47 + 0.48 + 0.48 - 0.49 0.50 +
Firebase Android SDK 10.2.0 + 11.0.0 + 11.0.0 + 11.4.2 + 11.6.0 + 11.6.2 +
Firebase iOS SDK 3.15.0 + 4.0.0 + 4.0.0 + 4.3.0 + 4.5.0 + 4.7.0 +

Documentation

To check out our latest docs, visit rnfirebase.io

Questions

For questions and support please use our Discord chat or Stack Overflow. The issue list of this repo is exclusively for bug reports.

Issues

Please make sure to complete the issue template before opening an issue. Issues not conforming to the guidelines may be closed immediately.

Feature Requests

For feature requests please use our Canny Board.

Changelog

Detailed changes for each release are documented in the releases notes.


Supporting RNFirebase

RNFirebase is an Apache-2.0 licensed open source project. It's an independent project with its ongoing development made possible entirely thanks to the support by these awesome sponsors and backers. If you'd like to join them, please consider:

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Backers

Thank you to all our backers! 🙏 [Become a backer]

Contributing

Please make sure to read the Contributing Guide before making a pull request.

Thank you to all the people who have already contributed to RNFirebase!


License