React Query Firebase

A set of React Query hooks integrating with Firebase.

📚 DocumentationLicense

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

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

See below for a full list of available packages.

Packages

  • @react-query-firebase/auth
  • @react-query-firebase/database
  • @react-query-firebase/firestore
  • @react-query-firebase/functions

View the documentation for full usage and examples.

License