0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-18 19:33:22 +00:00
query/docs/framework/vue/reference/functions/useIsMutating.md
Wonsuk Choi f38e6271b4
chore(*): update '@tanstack/typedoc-config' to v0.3.5 (#12035)
* chore(scripts/generate-docs): read type alias bodies whose type parameters have defaults

* chore(*): update '@tanstack/typedoc-config' to v0.3.5
2026-10-17 11:14:03 +09:00

1.5 KiB

id title redirect_from
useIsMutating useIsMutating
framework/vue/reference/useIsMutating
function useIsMutating(filters?: UseIsMutatingFilters, queryClient?: QueryClient): Ref<number>;

Defined in: packages/vue-query/src/useMutationState.ts:55

The useIsMutating composable returns a ref to the number of mutations that your application currently has pending (useful for app-wide loading indicators).

filters may be a plain object, MaybeRefDeep, or a reactive getter (() => ({ ... })) — pass a getter if the filters themselves depend on other reactive state.

Parameters

filters?

UseIsMutatingFilters = {}

The MutationFilters to narrow down the matched mutations.

queryClient?

QueryClient

Use this to use a custom QueryClient. Otherwise, the one provided by VueQueryPlugin will be used.

Returns

Ref<number>

A ref to the number of the mutations that your application currently has pending.

Example

<script setup lang="ts">
import { useIsMutating } from '@tanstack/vue-query'

// How many mutations matching the posts prefix are in progress?
const isMutatingPosts = useIsMutating({ mutationKey: ['posts'] })
</script>

<template>
  <span v-if="isMutatingPosts">Saving posts...</span>
</template>