0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/solid/reference/functions/QueryClientProvider.md
Wonsuk Choi 2c39f03b44
docs(solid-query): add JSDoc to the exported classes, methods, and arrow functions (#11882)
* docs(solid-query): add JSDoc to the exported classes, methods, and arrow functions

* docs(solid-query-persist-client/PersistQueryClientProvider): describe what is deferred while restoring and when the callbacks run
2026-10-04 12:34:40 +09:00

1.1 KiB

id title
QueryClientProvider QueryClientProvider
function QueryClientProvider(props: QueryClientProviderProps): Element;

Defined in: packages/solid-query/src/QueryClientProvider.tsx:100

Use the QueryClientProvider component to connect and provide a QueryClient to your application. Also calls client.mount()/client.unmount() as this component mounts/unmounts, which subscribes the client to focus/online events (resuming any paused mutations and refetching as needed when the app regains focus or comes back online).

Parameters

props

QueryClientProviderProps

The client to provide, and the children that get access to it.

Returns

Element

The provided children, wrapped so they can read the QueryClient via useQueryClient.

Example

import { QueryClient, QueryClientProvider } from '@tanstack/solid-query'

const queryClient = new QueryClient()

function App() {
  return <QueryClientProvider client={queryClient}>...</QueryClientProvider>
}