upstream-tanstack-query/docs/framework/react/reference/functions/useIsMutating.md

id, title, redirect_from

id	title	redirect_from
useIsMutating	useIsMutating	framework/react/reference/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?

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
}