mirror of
https://github.com/TanStack/query.git
synced 2026-11-16 22:50:20 +00:00
* docs(*): add parameter and result property tables to reference function pages and an overview to overloaded ones * docs(*): link to the base type's properties when a parameter or result type has no property table * docs(framework/*/reference): regenerate reference docs * docs(framework/*/reference): regenerate reference docs * chore(scripts/generate-docs): restore the 'dirname' import that the merge dropped * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): label overloads in the overview with their declared parameter and return types * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): convert declared intersection types from the source so signatures keep their alias names * docs(framework/*/reference): regenerate reference docs * docs(scripts/generate-docs): reword a comment to avoid the unknown word 'inlines' * docs(scripts/generate-docs): skip a parameter table on overloaded pages when its heading is missing
2.6 KiB
2.6 KiB
| id | title | redirect_from | |
|---|---|---|---|
| useIsFetching | useIsFetching |
|
function useIsFetching(filters?: QueryFilters<readonly unknown[]>, queryClient?: QueryClient): number;
Defined in: packages/react-query/src/useIsFetching.ts:41
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?
QueryFilters<readonly unknown[]>
The QueryFilters to narrow down the matched queries.
filters properties
| Property | Type | Default value | Description |
|---|---|---|---|
exact? |
boolean |
undefined |
Match query key exactly |
fetchStatus? |
"fetching" | "paused" | "idle" |
undefined |
Include queries matching their fetchStatus |
predicate? |
(query: Query) => boolean |
undefined |
Include queries matching this predicate function |
queryKey? |
TQueryKey | TuplePrefixes<TQueryKey> |
undefined |
Include queries matching this query key |
stale? |
boolean |
undefined |
Include or exclude stale queries |
type? |
QueryTypeFilter |
'all' |
Filter to active queries, inactive queries or all queries |
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
}