status-im
/
react-native-firebase
mirror of
2
0
Fork 0
Code Issues Projects Releases Wiki Activity
react-native-firebase/docs
History
Chris Bianca 4813fa9acc [docs] Add migration guide for v2 -> v3 2017-10-03 16:46:54 +01:00
..
contributing Update testing.md 2017-07-04 17:38:19 +01:00
core [docs] comment out todo 2017-08-26 06:50:03 +01:00
faq [docs] create separate folder for faqs 2017-08-26 06:47:13 +01:00
modules [docs] Add some basic Firestore docs for launch 2017-10-03 12:03:16 +01:00
v2 [docs] Remove references to Gitter 2017-09-21 09:10:32 +01:00
.nojekyll Move docs to docsify 2017-04-27 12:18:12 +01:00
README.md [docs] Update Twitter link 2017-10-03 16:24:10 +01:00
_navbar.md [docs] update doc styling 2017-08-26 03:59:48 +01:00
_sidebar.md [docs] Add some basic Firestore docs for launch 2017-10-03 12:03:16 +01:00
faqs.md [docs] added misc new doc files plus related todo's 2017-08-26 06:48:26 +01:00
icon.png [docs] added updated fav icon 2017-08-26 06:57:31 +01:00
index.html [docs] added groovy support to prism 2017-08-26 07:04:32 +01:00
initial-setup.md [docs][ios] Remove react native link support due to issues and update documentation 2017-06-13 16:18:12 +01:00
installation-android.md [docs] Add some basic Firestore docs for launch 2017-10-03 12:03:16 +01:00
installation-ios.md [docs] Add some basic Firestore docs for launch 2017-10-03 12:03:16 +01:00
migration-guide.md [docs] Add migration guide for v2 -> v3 2017-10-03 16:46:54 +01:00
redux.md Comments improved on react-redux-firebase example. 2017-08-31 01:17:44 -07:00
sw.js Create sw.js 2017-05-02 09:54:10 +01:00
usage.md [docs] update usage doc 2017-08-26 06:46:37 +01:00

README.md

!> These docs are for the v3 pre-release version, for the currently published release version see the v2 docs
[![npm version](https://img.shields.io/npm/v/react-native-firebase.svg?style=flat-square)](https://www.npmjs.com/package/react-native-firebase) [![NPM downloads](https://img.shields.io/npm/dm/react-native-firebase.svg?style=flat-square)](https://www.npmjs.com/package/react-native-firebase) [![Package Quality](https://npm.packagequality.com/shield/react-native-firebase.svg?style=flat-square)](http://packagequality.com/#?package=react-native-firebase) [![License](https://img.shields.io/npm/l/react-native-firebase.svg?style=flat-square)](/LICENSE) [![Chat](https://img.shields.io/badge/chat-on%20discord-7289da.svg?style=flat-square)](https://discord.gg/t6bdqMs) [![Donate](https://img.shields.io/badge/Donate-Patreon-green.svg?style=flat-square)](https://www.patreon.com/invertase) [![Twitter Follow](https://img.shields.io/twitter/follow/rnfirebase.svg?style=social&label=Follow)](https://twitter.com/rnfirebase)

RNFirebase 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, analyics 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 Web SDK
AdMob ❌ ✅ ✅ ❌
Analytics             ✅ ✅ ✅ ❌
App Indexing           ❌ ❌ ❌ ❌
Authentication ✅ ✅ ✅ ✅
-- Phone Auth ❌ ❌ ✅ ❌
Core ❌ ? ✅ ✅
-- Multiple Apps ❌ ❌ ✅ ✅
Cloud Messaging (FCM) ✅ ✅ ✅ ?
Crash Reporting ✅ ✅ ✅ ❌
Dynamic Links ❌ ❌ ❌ ❌
Firestore ❌ ❌ ✅ ❌
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
React Native 0.36 - 0.39 0.40 - 0.46 0.47 + 0.48 +
Firebase Android SDK 10.2.0 + 11.0.0 + 11.0.0 + 11.3.0 +
Firebase iOS SDK 3.15.0 + 4.0.0 + 4.0.0 + 4.2.0 +