useIsFetching

function useIsFetching(filters?, queryClient?): Accessor<number>;

Defined in: useIsFetching.ts:29

The useIsFetching hook returns the number of the queries that your application is loading or fetching in the background (useful for app-wide loading indicators).

Parameters#

filters?#

Accessor<QueryFilters<readonly unknown[]>>

An accessor returning the QueryFilters to narrow down the matched queries.

queryClient?#

Accessor<QueryClient>

An accessor for a custom QueryClient. Otherwise, the one from the nearest context will be used.

Returns#

Accessor<number>

An accessor for the number of the queries that your application is currently loading or fetching in the background.

Example#

import { useIsFetching } from '@tanstack/solid-query'

function GlobalLoadingIndicator() {
  // How many queries matching the posts prefix are fetching?
  const isFetchingPosts = useIsFetching(() => ({ queryKey: ['posts'] }))

  return isFetchingPosts() > 0 ? <span>Loading posts...</span> : null
}