mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(vue-query,solid-query): inline react reference content instead of 'ref'-ing hand-written react docs * docs(react-query): generate reference docs with TypeDoc * docs(vue-query,solid-query): fix dangling suspense-hook links left over from the react content copy * docs(solid-query): apply solid's callback call form to inlined reference examples * docs(react-query): correct inaccurate JSDoc statements flagged in review * docs(vue-query,solid-query): fix reactivity-aware examples and inaccurate type signatures flagged in review * docs(vue-query,solid-query): fix remaining type/behavior inaccuracies flagged in second review * docs(react-query): stop implying a default queryFn defers a fetch the way 'enabled: false' does * docs(vue-query): mark 'mutate'/'mutateAsync' per-call options as optional
1.4 KiB
1.4 KiB
| id | title |
|---|---|
| useIsFetching | useIsFetching |
function useIsFetching(filters?, queryClient?): number;
Defined in: react-query/src/useIsFetching.ts:44
useIsFetching is an optional hook that returns the number of the queries that your application is loading or
fetching in the background (useful for app-wide loading indicators).
Parameters
filters?
QueryFilters<readonly unknown[]>
The QueryFilters to narrow down the matched queries.
queryClient?
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/react-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/react-query'
function GlobalLoadingIndicator() {
const isFetching = useIsFetching()
return isFetching ? (
<div>Queries are fetching in the background...</div>
) : null
}