Open History to see the last commit
function useIsFetching(filters?: Omit<QueryFilters<readonly unknown[]>, "fetchStatus">, queryClient?: QueryClient): number;
Defined in: packages/preact-query/src/useIsFetching.ts:40
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?#
Omit<QueryFilters<readonly unknown[]>, "fetchStatus">
The QueryFilters to narrow down the matched queries.
filters properties#
Built from QueryFilters. See the type above for what it changes.
queryClient?#
Use this to use a custom QueryClient. Otherwise, the one from the nearest context will
be used.
Returns#
number
Will be the number of the queries that your application is currently loading or fetching in the
background.
Examples#
import { useIsFetching } from '@tanstack/preact-query'
function PostsFetchingIndicator() {
// How many queries matching the posts prefix are fetching?
const isFetchingPosts = useIsFetching({ queryKey: ['posts'] })
return isFetchingPosts ? <span>Refreshing posts...</span> : null
}
A global loading indicator for any query fetching in the background, not just the ones on screen:
import { useIsFetching } from '@tanstack/preact-query'
function GlobalLoadingIndicator() {
const isFetching = useIsFetching()
return isFetching ? (
<div>Queries are fetching in the background...</div>
) : null
}