Skip to content
Source
Sign inSign up
TanStack/query
Open History to see the last commit

react-native.md

121 lines4.0 KB

1---
2id: react-native
3title: React Native
4---
5​
6React Query is designed to work out of the box with React Native, with the exception of the devtools, which are only supported with React DOM at this time.
7​
8There is a 3rd party [Expo](https://docs.expo.dev/) plugin which you can try: https://github.com/expo/dev-plugins/tree/main/packages/react-query
9​
10There is a 3rd party [Flipper](https://fbflipper.com/docs/getting-started/react-native/) plugin which you can try: https://github.com/bgaleotti/react-query-native-devtools
11​
12There is a 3rd party [Reactotron](https://github.com/infinitered/reactotron/) plugin which you can try: https://github.com/hsndmr/reactotron-react-query
13​
14If you would like to help us make the built-in devtools platform agnostic, please let us know!
15​
16## Online status management
17​
18React Query already supports auto refetch on reconnect in web browser.
19To add this behavior in React Native you have to use React Query `onlineManager` as in the example below:
20​
21```tsx
22import NetInfo from '@react-native-community/netinfo'
23import { onlineManager } from '@tanstack/react-query'
24​
25onlineManager.setEventListener((setOnline) => {
26 return NetInfo.addEventListener((state) => {
27 setOnline(!!state.isConnected)
28 })
29})
30```
31​
32or
33​
34```tsx
35import { onlineManager } from '@tanstack/react-query'
36import * as Network from 'expo-network'
37​
38onlineManager.setEventListener((setOnline) => {
39 const eventSubscription = Network.addNetworkStateListener((state) => {
40 setOnline(!!state.isConnected)
41 })
42 return eventSubscription.remove
43})
44```
45​
46## Refetch on App focus
47​
48Instead of event listeners on `window`, React Native provides focus information through the [`AppState` module](https://reactnative.dev/docs/appstate#app-states). You can use the `AppState` "change" event to trigger an update when the app state changes to "active":
49​
50```tsx
51import { useEffect } from 'react'
52import { AppState, Platform } from 'react-native'
53import type { AppStateStatus } from 'react-native'
54import { focusManager } from '@tanstack/react-query'
55​
56function onAppStateChange(status: AppStateStatus) {
57 if (Platform.OS !== 'web') {
58 focusManager.setFocused(status === 'active')
59 }
61​
62useEffect(() => {
63 const subscription = AppState.addEventListener('change', onAppStateChange)
64​
65 return () => subscription.remove()
66}, [])
67```
68​
69## Refresh on Screen focus
70​
71In some situations, you may want to refetch the query when a React Native Screen is focused again.
72This custom hook will call the provided `refetch` function when the screen is focused again.
73​
74```tsx
75import React from 'react'
76import { useFocusEffect } from '@react-navigation/native'
77​
78export function useRefreshOnFocus<T>(refetch: () => Promise<T>) {
79 const firstTimeRef = React.useRef(true)
80​
81 useFocusEffect(
82 React.useCallback(() => {
83 if (firstTimeRef.current) {
84 firstTimeRef.current = false
85 return
86 }
87​
88 refetch()
89 }, [refetch]),
90 )
92```
93​
94In the above code, `refetch` is skipped the first time because `useFocusEffect` calls our callback on mount in addition to screen focus.
95​
96## Disable queries on out of focus screens
97​
98If you don’t want certain queries to remain “live” while a screen is out of focus, you can use the subscribed prop on useQuery. This prop lets you control whether a query stays subscribed to updates. Combined with React Navigation’s useIsFocused, it allows you to seamlessly unsubscribe from queries when a screen isn’t in focus:
99​
100Example usage:
101​
102```tsx
103import React from 'react'
104import { useIsFocused } from '@react-navigation/native'
105import { useQuery } from '@tanstack/react-query'
106import { Text } from 'react-native'
107​
108function MyComponent() {
109 const isFocused = useIsFocused()
110​
111 const { dataUpdatedAt } = useQuery({
112 queryKey: ['key'],
113 queryFn: () => fetch(...),
114 subscribed: isFocused,
115 })
116​
117 return <Text>DataUpdatedAt: {dataUpdatedAt}</Text>
119```
120​
121When subscribed is false, the query unsubscribes from updates and won’t trigger re-renders or fetch new data for that screen. Once it becomes true again (e.g., when the screen regains focus), the query re-subscribes and stays up to date.