README.md

React Firehooks 🔥🪝

Lightweight dependency-free collection of React hooks for Firebase.

Installation

npm install react-firehooks

or

yarn add react-firehooks

Compatibility

• firebase: 10.5.0 or later
• react: 16.8.0 or later

Usage

Type Documentation

This library consists of 6 modules with many hooks:

• app-check
• auth
• database
• firestore
• messaging
• storage

All hooks can be imported from react-firehooks directly or via react-firehooks/<module> to improve tree-shaking and bundle size.

Development

Build

To build the library, first install the dependencies, then run npm run build.

npm install
npm run build

Tests

To run the tests, first install the dependencies, then run npm test. Watch mode can be started with npm test -- --watch.

npm install
npm test

Resources

React Firebase Hooks

This library is heavily inspired by react-firebase-hooks. It was created because react-firebase-hooks seemed unmaintained and did not support Firebase v9 for a couple of months. react-firehooks is not a fork but a completely new code base exporting almost identical hooks.

License

MIT