TanStack Query Firebase

TanStack Query Firebase provides a set of hooks for handling asynchronous tasks with Firebase in your applications.

The library is still heavily work-in-progress! Ensure your required functionality is supported before continuing.

When managing Firebase's asynchronous API calls within your application, state synchronization can become cumbersome in most applications. You will commonly find yourself handling loading states, error states, and data synchronization manually.

This library provides a hands-off approach to these problems, by leveraging the popular TanStack Query project. Out of the box, you get:

  • Automatic Caching: Avoid redundant Firebase calls with built-in caching.
  • Out-of-the-box Synchronization: TanStack Query keeps your UI in sync with the Firebase backend effortlessly.
  • Background Updates: Fetch and sync data seamlessly in the background without interrupting the user experience.
  • Error Handling & Retries: Get automatic retries on failed Firebase calls, with robust error handling baked in.
  • Dev Tools for Debugging: Leverage the React Query Devtools to gain insights into your data-fetching logic and Firebase interactions.

By combining Firebase with TanStack Query, you can make your app more resilient, performant, and scalable, all while writing less code.

Looking for React Query Firebase? Check out the old branch.

Framework Installation

This project aims to support hooks for all major frameworks which TanStack supports; React, Vue, Solid, Angular, and Svelte. Development is still in progress, with an initial focus on React.

To get started with your framework of choice, view the following documentation: