0
Fork 0
mirror of https://github.com/TanStack/query.git synced 2026-11-16 22:50:20 +00:00
query/docs/framework/preact/reference/functions/QueryClientProvider.md
Wonsuk Choi e57f8163b1
docs(query-core): add JSDoc across the package and expose it in generated reference docs (#11438)
* docs(query-core): add JSDoc across the package and expose it in generated reference docs

* docs(config.json): add sidebar entries for newly generated query-core reference docs

* docs(query-core): migrate remaining prose from the legacy 'docs/reference' pages into JSDoc

* docs(query-core): remove legacy 'docs/reference' pages superseded by the generated reference

* docs(query-core): regenerate reference docs after merging main

* docs(query-core): document missing default values for MutationOptions, combine, and QueryFilters.type

* fix(query-devtools): drop unnecessary 'query-core' project reference

* docs(query-core): document missing default values and normalize 'Defaults to' spacing

* docs(query-core): fix 'environmentManager' JSDoc example
2026-09-07 18:22:38 +02:00

1.1 KiB

id title
QueryClientProvider QueryClientProvider
function QueryClientProvider(__namedParameters): VNode;

Defined in: packages/preact-query/src/QueryClientProvider.tsx:70

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

__namedParameters

QueryClientProviderProps

Returns

VNode

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

Example

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

const queryClient = new QueryClient()

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