Skip to content

Latest commit

 

History

History
45 lines (27 loc) · 2.39 KB

README.md

File metadata and controls

45 lines (27 loc) · 2.39 KB

React Firebase Hooks

A set of reusable React Hooks for Firebase.

npm version npm downloads

This documentation is for v3 of React Firebase Hooks which involved a number of breaking changes, including adding support for Firebase v8.0.0 - more details here. For v2 documentation, see here.

Installation

React Firebase Hooks v3 requires React 16.8.0 or later and Firebase v8.0.0 or later.

Official support for Hooks was added to React Native in v0.59.0. React Firebase Hooks works with both the Firebase JS SDK and React Native Firebase, although some of the typings may be incorrect.

# with npm
npm install --save react-firebase-hooks

# with yarn
yarn add react-firebase-hooks

This assumes that you’re using the npm or yarn package managers with a module bundler like Webpack or Browserify to consume CommonJS modules.

Why?

There has been a lot of hype around React Hooks, but this hype merely reflects that there are obvious real world benefits of Hooks to React developers everywhere.

This library explores how React Hooks can work to make integration with Firebase even more straightforward than it already is. It takes inspiration for naming from RxFire and is based on an internal library that we had been using in a number of apps prior to the release of React Hooks. The implementation with hooks is 10x simpler than our previous implementation.

Upgrading from v2 to v3

To upgrade your project from v2 to v3 check out the Release Notes which have full details of everything that needs to be changed.

Documentation

License