Skip to content
dev-docs

useIsMutating

Source URL: https://tanstack.com/query/latest/docs/framework/react/reference/useIsMutating

useIsMutating

Section titled “useIsMutating”

useIsMutating is an optional hook that returns the number of mutations that your application is fetching (useful for app-wide loading indicators).

import { useIsMutating } from '@tanstack/react-query'
// How many mutations are fetching?
const isMutating = useIsMutating()
// How many mutations matching the posts prefix are fetching?
const isMutatingPosts = useIsMutating({ mutationKey: ['posts'] })

Options

  • filters?: MutationFilters: Mutation Filters
  • queryClient?: QueryClient
    • Use this to use a custom QueryClient. Otherwise, the one from the nearest context will be used.

Returns

  • isMutating: number
    • Will be the number of the mutations that your application is currently fetching.