snapshot of https://github.com/TanStack/query.git (main, 2026-09-16; blobs > 131072B omitted)
This commit is contained in:
65
docs/framework/lit/reference/functions/useIsMutating.md
Normal file
65
docs/framework/lit/reference/functions/useIsMutating.md
Normal file
@@ -0,0 +1,65 @@
|
||||
---
|
||||
id: useIsMutating
|
||||
title: useIsMutating
|
||||
---
|
||||
|
||||
```ts
|
||||
function useIsMutating(
|
||||
host,
|
||||
filters,
|
||||
queryClient?): IsMutatingAccessor;
|
||||
```
|
||||
|
||||
Defined in: [packages/lit-query/src/useIsMutating.ts:147](https://github.com/TanStack/query/blob/main/packages/lit-query/src/useIsMutating.ts#L147)
|
||||
|
||||
Creates a Lit reactive controller that tracks how many matching mutations are
|
||||
currently pending.
|
||||
|
||||
When `filters` is a function, it is re-read during host updates so the count
|
||||
can follow reactive host state. If `queryClient` is omitted, the controller
|
||||
resolves the client from the nearest connected `QueryClientProvider`.
|
||||
|
||||
## Parameters
|
||||
|
||||
### host
|
||||
|
||||
`ReactiveControllerHost`
|
||||
|
||||
The Lit reactive controller host that owns the cache
|
||||
subscription.
|
||||
|
||||
### filters
|
||||
|
||||
[`Accessor`](../type-aliases/Accessor.md)\<[`MutationFilters`](../interfaces/MutationFilters.md)\<`unknown`, `Error`, `unknown`, `unknown`\>\> = `{}`
|
||||
|
||||
Mutation filters, or a getter that returns mutation filters.
|
||||
|
||||
### queryClient?
|
||||
|
||||
[`QueryClient`](../classes/QueryClient.md)
|
||||
|
||||
Optional explicit query client. Provide this for
|
||||
controllers that should not resolve a client from Lit context.
|
||||
|
||||
## Returns
|
||||
|
||||
[`IsMutatingAccessor`](../type-aliases/IsMutatingAccessor.md)
|
||||
|
||||
An accessor for the current number of matching pending mutations.
|
||||
|
||||
## Example
|
||||
|
||||
```ts
|
||||
import { LitElement, html } from 'lit'
|
||||
import { useIsMutating } from '@tanstack/lit-query'
|
||||
|
||||
class MutationStatus extends LitElement {
|
||||
private readonly savesPending = useIsMutating(this, {
|
||||
mutationKey: ['save-project'],
|
||||
})
|
||||
|
||||
render() {
|
||||
return html`<span>${this.savesPending()} saves pending</span>`
|
||||
}
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user