87 lines
4.6 KiB
Markdown
87 lines
4.6 KiB
Markdown
# React Native Firebase<a href="https://invertase.io/react-native-firebase"><img align="left" src="http://i.imgur.com/01XQL0x.png"></a>
|
||
|
||
[](https://www.npmjs.com/package/react-native-firebase)
|
||
[](https://www.npmjs.com/package/react-native-firebase)
|
||
[](http://packagequality.com/#?package=react-native-firebase)
|
||
[](/LICENSE)
|
||
[](https://discord.gg/t6bdqMs)
|
||
[](https://gitter.im/invertase/react-native-firebase)
|
||
[](https://www.patreon.com/invertase)
|
||
|
||
|
||
**RNFirebase** makes using [Firebase](http://firebase.com) with React Native simple.
|
||
|
||
<hr>
|
||
|
||
> [Documentation](https://invertase.io/react-native-firebase) <b>|</b> [iOS Install Guide](http://invertase.io/react-native-firebase/#/installation-ios) <b>|</b> [Android Install Guide](http://invertase.io/react-native-firebase/#/installation-android) <b>|</b> [FAQs](http://invertase.io/react-native-firebase/#/faqs) <b>|</b> [Feature Requests](https://react-native-firebase.canny.io/feature-requests)
|
||
|
||
<hr>
|
||
|
||
### Install
|
||
```bash
|
||
npm i react-native-firebase --save
|
||
```
|
||
|
||
<hr>
|
||
|
||
### Why
|
||
|
||
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, 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 | Web SDK |
|
||
| ---------------------- | :---: | :---: | :---: | :---: |
|
||
| **AdMob** | ❌ | ✅ | ✅ | ❌ |
|
||
| **Analytics** | ✅ | ✅ | ✅ | ❌ |
|
||
| **App Indexing** | ❌ | ❌ | ❌ | ❌ |
|
||
| **Authentication** | ✅ | ✅ | ✅ | ✅ |
|
||
| _-- Phone Auth_ | ❌ | ❌ | ✅ | ❌ |
|
||
| **Core** | ❌ |**?**| ✅ | ✅ |
|
||
| _-- Multiple Apps_ | ❌ | ❌ | ✅ | ✅ |
|
||
| **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 | v3 |
|
||
| ---------------------- | :---: | :---: | :---: |
|
||
| Firebase Android SDK | 10.2.0+ | 11.0.0 + | 11.2.0 + |
|
||
| Firebase iOS SDK | 3.15.0+ | 4.0.0 + | 4.0.0 + |
|
||
|
||
---
|
||
|
||
### License
|
||
|
||
- MIT
|