Skip to content

docs: clarify queryClient refetch behavior for stale queries #9560

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs: clarify queryClient refetch behavior for stale queries #9560

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2fa0b8
docs(queryClient): add example for refetchQueries with stale: true an…
imadselka Aug 12, 2025
b0ab0d5
docs(react-native): modify useRefreshOnFocus example
imadselka Aug 12, 2025
77c4429
docs(react-native): add queryKey in useRefreshOnFocus example
imadselka Aug 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 8 additions & 5 deletions docs/framework/react/react-native.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,13 +74,15 @@ useEffect(() => {
## Refresh on Screen focus

In some situations, you may want to refetch the query when a React Native Screen is focused again.
This custom hook will call the provided `refetch` function when the screen is focused again.
This custom hook will refetch **all active stale queries** when the screen is focused again.

```tsx
import React from 'react'
import { useFocusEffect } from '@react-navigation/native'
import { useQueryClient } from '@tanstack/react-query'

export function useRefreshOnFocus<T>(refetch: () => Promise<T>) {
export function useRefreshOnFocus() {
const queryClient = useQueryClient()
const firstTimeRef = React.useRef(true)

useFocusEffect(
Expand All @@ -90,13 +92,14 @@ export function useRefreshOnFocus<T>(refetch: () => Promise<T>) {
return
}

refetch()
}, [refetch]),
// refetch all stale active queries
queryClient.refetchQueries({ queryKey:['posts'], stale: true, type: 'active' })
}, [queryClient]),
)
}
```

In the above code, `refetch` is skipped the first time because `useFocusEffect` calls our callback on mount in addition to screen focus.
In the above code, The first focus (when the screen is initially mounted) is skipped because `useFocusEffect` calls our callback on mount in addition to screen focus.

## Disable queries on out of focus screens

Expand Down