Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hannojg/react-native-firebase-hooks
React Hooks for React Native Firebase
https://github.com/hannojg/react-native-firebase-hooks
firebase hooks react-native
Last synced: 18 days ago
JSON representation
React Hooks for React Native Firebase
- Host: GitHub
- URL: https://github.com/hannojg/react-native-firebase-hooks
- Owner: hannojg
- License: apache-2.0
- Created: 2021-12-10T07:51:58.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2022-07-04T11:12:34.000Z (over 2 years ago)
- Last Synced: 2024-04-24T21:21:36.639Z (7 months ago)
- Topics: firebase, hooks, react-native
- Language: TypeScript
- Homepage:
- Size: 966 KB
- Stars: 26
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# 🔥⚓️ react-native-firebase-hooks
React Hooks for React Native Firebase
## Installation
```
yarn add @skillnation/react-native-firebase-hooks
```
_Note:_ This assumes you have setup [react-native-firebase](https://rnfirebase.io/) in your project.
## Usage
### Example
```tsx
import React from 'react';
import type { Product } from './types';
import firestore from '@react-native-firebase/firestore';
import { useCollectionData } from '@skillnation/react-native-firebase-hooks/firestore';
export const App: React.FC = () => {
const [products, isLoading, error] = useCollectionData(
firestore().collection('products')
);
if (isLoading) return
if (error) return
return ;
};
```
### Documentation
⚠️ These doc links redirect to [`react-firebase-hooks`](https://github.com/CSFrequency/react-firebase-hooks).
The API is exactly the same as [`react-firebase-hooks`](https://github.com/CSFrequency/react-firebase-hooks).
Only the imports are different:
```diff
- import {} from 'react-firebase-hooks/MODULE_NAME'
+ import {} from '@skillnation/react-native-firebase-hooks/MODULE_NAME'
```
- [Authentication Hooks](https://github.com/CSFrequency/react-firebase-hooks/tree/v4.0.2/auth)
- [Cloud Firestore Hooks](https://github.com/CSFrequency/react-firebase-hooks/tree/v4.0.2/firestore)
- [Cloud Functions Hooks](https://github.com/CSFrequency/react-firebase-hooks/tree/v4.0.2/functions)
- [Cloud Messaging Hooks](https://github.com/CSFrequency/react-firebase-hooks/tree/v4.0.2/messaging)
- [Cloud Storage Hooks](https://github.com/CSFrequency/react-firebase-hooks/tree/v4.0.2/storage)
- [Realtime Database Hooks](https://github.com/CSFrequency/react-firebase-hooks/tree/v4.0.2/database)
## Why use this instead of `react-firebase-hooks`?
`react-firebase-hooks` is [incompatible](https://github.com/CSFrequency/react-firebase-hooks/issues/181#issue-1046383491) with the latest versions of [`react-native-firebase`](https://rnfirebase.io/), especially from a types perspective.
This library works internally mostly the same as react-firebase-hooks.
So you really only want to use this lib for react-native if you are using [`react-native-firebase`](https://rnfirebase.io/).
## Migrating from `react-firebase-hooks`
The only thing you have to do is to change the imports:
```diff
- import {} from 'react-firebase-hooks/MODULE_NAME'
+ import {} from '@skillnation/react-native-firebase-hooks/MODULE_NAME'
```
Note however, that this library is based on [`react-firebase-hooks` v4](https://github.com/CSFrequency/react-firebase-hooks/tree/v4.0.2), as this version was for the Firebase JS SDK v8, which had a very similar API to the native SDKs.
We **do** include features of newer versions of `react-firebase-hooks` (such as the `reload()` callback on `use*Once` hooks, which was added in v5).
However, any change in newer version that is for compatibility with Firebase Js SDJ v9 won't be added to this library. This is due to the fact that the firebase JS SDK has a different API from the native SDKs, so we can't have 100% feature parity.
As an example [FirestoreDataConverter](https://firebase.google.com/docs/reference/js/firestore_.firestoredataconverter) is something that just exists in the Firebase v9 JS SDK, and can't be added here.
## Contributing
See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
## License
MIT