React Query Firebase

React Query Firebase provides a set of easy to use hooks for common Firebase usecases. Each hook wraps around React Query, allowing to easily integrate the hooks into a new or existing project, whilst enjoying the powerful benefits React Query offers.

The exported hooks do not manage Query Keys or Firebase instances, giving you full control over integration.

Installation

If you haven't done so already, install react, react-query & firebase (v9):

npm i --save react react-query firebase

Note: The library only supports Firebase JS SDK v9 - learn more about it here!

Before using this library, ensure React Query is setup on your project by following the Installation guide.

Next install one of the React Query Firebase packages, e.g:

npm i --save @react-query-firebase/firestore

Core Concepts

Each package behaves with the same core concepts which are important to understand:

  • Query based hooks are fetched according to your React Query Defaults or per-hook configuration (as expected!).
  • Query based hooks will refetch on Query Key changes, not on Firebase argument changes. For example, if you change a Firestore Query argument you should also update the Query Key to ensure the hook is re-fetched.

Packages

Miscellaneous