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

HydrationBoundaryProps.md

19 lines1.3 KB

1---
2id: HydrationBoundaryProps
3title: HydrationBoundaryProps
4---
5​
6<!-- DO NOT EDIT: this page is autogenerated from the type comments -->
7​
8Defined in: [packages/react-query/src/HydrationBoundary.tsx:15](https://github.com/TanStack/query/blob/main/packages/react-query/src/HydrationBoundary.tsx#L15)
9​
10The props accepted by `HydrationBoundary`.
11​
12## Properties
13​
14| Property | Type | Description |
15| ------ | ------ | ------ |
16| <a id="property-children"></a> `children?` | `ReactNode` | The components to render β€” always rendered unconditionally, not gated on hydration. New queries are hydrated into the cache during render; for queries that already exist in the cache, only newer dehydrated data is hydrated, and that happens in an effect after commit, so `children` may render briefly before it lands. |
17| <a id="property-options"></a> `options?` | [`OmitKeyof`](../type-aliases/OmitKeyof.md)\<[`HydrateOptions`](HydrateOptions.md), `"defaultOptions"`\> & `object` | Optional. Note: unlike `hydrate`, `mutations` cannot be set here. |
18| <a id="property-queryclient"></a> `queryClient?` | [`QueryClient`](../classes/QueryClient.md) | Use this to use a custom `QueryClient`. Otherwise, the one from the nearest context will be used. |
19| <a id="property-state"></a> `state` | [`DehydratedState`](DehydratedState.md) \| `null` \| `undefined` | The state to hydrate. |