67 lines
3.7 KiB
Markdown
67 lines
3.7 KiB
Markdown
|
|
|||
|
<h1 align="center">
|
|||
|
<img src="https://camo.githubusercontent.com/6c827e5a0bb91259f82a1f4923ab7efa4891b119/687474703a2f2f692e696d6775722e636f6d2f303158514c30782e706e67"/><br>
|
|||
|
|
|||
|
React Native Firebase
|
|||
|
</h1>
|
|||
|
|
|||
|
<div style="text-align: center;">
|
|||
|
[![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)
|
|||
|
[![Chat](https://img.shields.io/badge/chat-on%20gitter-a0e7a0.svg?style=flat-square)](https://gitter.im/invertase/react-native-firebase)
|
|||
|
[![Donate](https://img.shields.io/badge/Donate-Patreon-green.svg?style=flat-square)](https://www.patreon.com/invertase)
|
|||
|
</div>
|
|||
|
|
|||
|
---
|
|||
|
|
|||
|
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](https://www.npmjs.com/package/firebase) 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](https://facebook.github.io/react-native/docs/performance.html#javascript-frame-rate). 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 from the Firebase Web SDK are usable within React Native.
|
|||
|
|
|||
|
| Firebase Features | v1 | v2 | Web SDK |
|
|||
|
| ---------------------- | :---: | :---: | :---: |
|
|||
|
| AdMob | ❌ | ✅ | ❌ |
|
|||
|
| Analytics | ✅ | ✅ | ❌ |
|
|||
|
| App Indexing | ❌ | ❌ | ❌ |
|
|||
|
| Authentication | ✅ | ✅ | ✅ |
|
|||
|
| Cloud Messaging (FCM) | ✅ | ✅ | ❌ |
|
|||
|
| 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 version of `react-native-firebase` for different React Native versions
|
|||
|
|
|||
|
| | v0.36 - v0.39 | v0.40 - v0.46 | v0.47 +
|
|||
|
| ------------------------------- | :---: | :---: | :---: |
|
|||
|
| react-native-firebase | 1.X.X | 2.X.X | 2.1.X |
|
|||
|
|
|||
|
> The table below shows the minimum supported versions of the Firebase SDKs for each version of `react-native-firebase`
|
|||
|
|
|||
|
| | v1 | v2 |
|
|||
|
| ---------------------- | :---: | :---: |
|
|||
|
| Firebase Android SDK | 10.2.0+ | 11.0.0 + |
|
|||
|
| Firebase iOS SDK | 3.15.0+ | 4.0.0 + |
|