mirror of
https://github.com/TanStack/query.git
synced 2026-11-18 19:33:22 +00:00
* docs(query-core): add JSDoc across the package and expose it in generated reference docs * docs(config.json): add sidebar entries for newly generated query-core reference docs * docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc * docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference * docs(query-core): regenerate reference docs after merging main * docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type * fix(query-devtools): drop unnecessary 'query-core' project reference * docs(query-core): document missing default values and normalize 'Defaults to' spacing * docs(query-core): fix 'environmentManager' JSDoc example
1.3 KiB
1.3 KiB
| id | title | redirect_from | |
|---|---|---|---|
| useIsMutating | useIsMutating |
|
function useIsMutating(filters?, queryClient?): number;
Defined in: packages/react-query/src/useMutationState.ts:35
The useIsMutating hook returns the number of mutations that your application currently has pending
(useful for app-wide loading indicators).
Parameters
filters?
MutationFilters<unknown, Error, unknown, unknown>
The MutationFilters to narrow down the matched mutations.
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 mutations that your application currently has pending.
Example
import { useIsMutating } from '@tanstack/react-query'
function PostsMutatingIndicator() {
// How many mutations matching the posts prefix are in progress?
const isMutatingPosts = useIsMutating({ mutationKey: ['posts'] })
return isMutatingPosts ? <span>Saving posts...</span> : null
}