译零 TransZero · TanStack Query 中文文档
主站

QueryClientProvider

更新于 2026-11-02 React 查看英文原文 ↗
TypeScript
1function QueryClientProvider(props: QueryClientProviderProps): Element;

定义位置:packages/react-query/src/QueryClientProvider.tsx:69

使用 QueryClientProvider 组件将 QueryClient 连接并提供给你的应用。该组件在挂载/卸载时还会调用 client.mount()/client.unmount(),从而让客户端订阅窗口焦点(focus)和网络在线(online)事件(当应用重新获得焦点或恢复联网时,会恢复任何已暂停的修改,并按需重新拉取查询)。

参数

props

QueryClientProviderProps

要提供的 client,以及可访问该 client 的 children。

props 属性

属性 类型 描述
children? React.ReactNode 可访问所提供 QueryClient 的组件。
client QueryClient 必填 要提供的 QueryClient 实例。

返回值

Element

所提供的 children,经封装后可通过 useQueryClient 读取 QueryClient。

示例

TypeScript
1import { QueryClient, QueryClientProvider } from '@tanstack/react-query'2 3const queryClient = new QueryClient()4 5function App() {6  return <QueryClientProvider client={queryClient}>...</QueryClientProvider>7}

本页为 TanStack Query 文档(React 版)的非官方中文翻译,原文由上游团队维护,遵循 MIT 许可。 译文如有偏差,以英文原文为准。

译自上游 59d11de