0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/react/reference/functions/useIsMutating.md
Wonsuk Choi 6e16d3946a
docs(query-core/utils): add missing JSDoc to utility functions (#11830)
* docs(query-core/utils): add missing JSDoc to utility functions

* docs(query-core/utils): clarify that 'addToEnd' and 'addToStart' drop at most one item

* docs(framework/*/reference): regenerate reference docs
2026-10-04 02:47:14 +09:00

1.3 KiB

id title redirect_from
useIsMutating useIsMutating
framework/react/reference/useIsMutating
function useIsMutating(filters?: MutationFilters<unknown, Error, unknown, unknown>, queryClient?: QueryClient): number;

Defined in: packages/react-query/src/useMutationState.ts:33

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?

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
}