docs(preact-query): add Suspense and Testing guides
The Preact docs had no counterpart for the React "Suspense" and
"Testing" guides even though `@tanstack/preact-query` ships the
suspense hooks and `QueryErrorResetBoundary`.
Follow the existing Preact docs convention: reference the React guide
via `ref:` + `replace:` and override only the React-specific sections
(`preact/compat` Suspense, an error boundary built on `useErrorBoundary`,
`@testing-library/preact`). The React guides only gain the section
markers needed for the overrides; their wording is unchanged.
* docs(preact-query): add 'select' example to 'useQuery'
* docs(preact-query): move 'select' example right after the basic 'useQuery' example
* docs(preact-query): make 'select' example derive a different type instead of a subset
* docs(preact-query): wrap 'useIsFetching' example in a component
* docs(preact-query): wrap 'useQueries' examples in components and add 'isError' handling
* docs(preact-query): wrap 'useIsMutating' and 'useMutationState' examples in components
* docs(preact-query): wrap 'queryOptions' examples in components
* docs(preact-query): wrap 'infiniteQueryOptions' example in a component
* fix(preact-query): correctly distinguish error state from loading in 'infiniteQueryOptions' example
* fix(preact-query): correct mutation terminology and filter by success status in 'useMutationState' examples
* docs(preact-query): destructure useInfiniteQuery result in 'infiniteQueryOptions' example
* docs(preact-query): rename 'variables' to 'pendingVariables' in 'useMutationState' example
* docs(preact-query): rename 'data' to 'savedPosts' in 'useMutationState' examples
* docs(preact-query): rename 'results'/'result' to 'addResults'/'addResult' in 'useMutation' Promise.allSettled example
* docs(preact-query): rename 'latest' to 'latestSavedPost' in 'useMutationState' example
* docs(preact-query): render fetched pages and handle loading/error states in 'useInfiniteQuery' examples
* docs(preact-query): render infinite query lists as '<ul>'/'<li>' instead of flat '<p>' tags
* docs(preact-query): show hover-triggered prefetch instead of an unlocated 'Elsewhere' comment in 'queryOptions'/'infiniteQueryOptions' examples
* docs(preact-query): move hover-prefetch examples from 'queryOptions'/'infiniteQueryOptions' to 'useQuery'/'useInfiniteQuery'
* docs(preact-query): render list examples as '<ul>'/'<li>' and fix undefined refs across remaining hooks
* docs(preact-query): name the prefetch id in 'queryOptions'/'infiniteQueryOptions' examples instead of an unexplained literal
* docs(preact-query): add 'skipToken' examples for type-safe conditional disabling
* docs(preact-query): use 'isLoading' with optional chaining in the infinite-query 'skipToken' examples
* docs(preact-query): add missing 'isPending'/'isError' handling across 'queryOptions'/'useQuery'/'infiniteQueryOptions'/'useInfiniteQuery' examples
* docs(preact-query): keep 'initialData' examples showing data alongside errors instead of hiding it
* docs(preact-query): use scroll-triggered pagination in 'useInfiniteQuery' examples, add a 'fetchNextPage' trigger to 'infiniteQueryOptions'
* docs(preact-query): guard scroll-triggered 'fetchNextPage' with 'isFetching', move cross-reference out of '@example'
* docs(preact-query): move duplicated usage examples from 'queryOptions'/'infiniteQueryOptions' into their hooks
* docs(preact-query): remove duplicated basic-mutation example from 'mutationOptions', trim boilerplate '@remarks'
* docs(preact-query): add 'combine' example to 'useSuspenseQueries', link 'useSuspenseInfiniteQuery' to 'useInfiniteQuery' and document its waterfall/refetch risks
* docs(preact-query): drop irrelevant 'useSuspenseQueries' reference from 'useSuspenseInfiniteQuery' waterfall remark
* docs(preact-query): strengthen 'useMutation''s '@see' pointer to 'mutationOptions' with its 'mutationKey' lookup benefit
* docs(preact-query): add blank lines around 'isPending'/'isError' guards for consistency with other examples
* docs(preact-query): warn about request waterfalls and point to 'useSuspenseQueries' in 'useSuspenseQuery'
* docs(preact-query): add multiple-parallel-queries example to 'useSuspenseQueries'
* fix(preact-query): guard 'fetchNextPage' example with 'isFetching', not just 'isFetchingNextPage'
* docs(preact-query): add global loading indicator example to 'useIsFetching'
* docs(preact-query): add mutation-state, 'Promise.all', and 'Promise.allSettled' examples to 'useMutation'
* docs(preact-query): add 'isPending'/'isError' example alongside 'status' to 'useQuery'
* docs(preact-query): fix dependent-query example in 'useQuery' to use 'isLoading' instead of 'isPending'
* docs(preact-query): add pagination example with 'keepPreviousData' to 'useQuery'
* docs(preact-query): correct consecutive-mutation callback wording in 'useMutation' example
* docs(preact-query): add per-call 'onError' callback to basic 'useMutation' example
* docs(preact-query): use contextual message in 'console.error' for 'Promise.all' example in 'useMutation'
* docs(preact-query): wrap bare 'QueryClient' type name in backticks in JSDoc
* docs(preact-query): backtick 'QueryClient' in 'children' prop doc and 'suspense'/'throwOnError' in QueryErrorResetBoundary
* docs(preact-query): document type parameters with '@template' and add 'useQueryClient' throws note
* docs(preact-query): fix TQueryData select direction and TResults/TDepth phrasing flagged by CodeRabbit
* docs(preact-query): document interfaces and type aliases with JSDoc for generated reference docs
* docs(preact-query): fix finite/infinite mix-ups and opaque-array fallback claims flagged by CodeRabbit
* docs(preact-query): document functions and components with JSDoc for generated reference docs
* docs(preact-query): replace concrete API calls with abstract fetcher names in JSDoc examples
* docs(preact-query): rename mutation example fetcher to be CRUD-neutral
* docs(preact-query): rename mutation example fetcher to 'createPosts'
* docs(preact-query): add examples for Suspense, prefetch, and options-builder functions
* docs(preact-query): add optimistic update, dependent query, and SSR hydration examples
* docs(preact-query): add parameterized factory and mutationKey lookup examples to queryOptions/mutationOptions
* docs(preact-query): add infiniteQueryOptions factory example and restore useMutationState's third example
* docs(preact-query): add TkDodo-inspired multi-API reuse, initialData, and per-call mutate callback examples
* docs(preact-query): document useIsRestoring, initialData, mutateAsync, and skipToken-excluded queryFn fields
* docs(preact-query): fill in empty Returns sections for hooks and options builders
* docs(preact-query): systematic sweep of generated pages for missing field descriptions and fix mismatched mutationOptions example
* docs(preact-query): split mutationOptions' mutationKey overload into basic usage and lookup examples
* docs(preact-query): fix overloads whose example didn't match their initialData-required type
* docs(preact-query): fill overloads missing examples and useSuspenseQueries' queryClient param description
* docs(preact-query): remove duplicated overload example and fix examples that failed type-checking
* docs(preact-query): describe every documented parameter and restore reverted overload example
* docs(preact-query): describe children props and low-level context exports
* fix(preact-query): remove inaccurate 'queryFn is optional' claim from infiniteQueryOptions overload
* docs(preact-query): add missing @returns to mutationOptions overloads and provider components
* docs(preact-query): describe QueryErrorResetBoundary children and its render-function parameter
* docs(preact-query): fix prose-accuracy issues found by multi-agent audit
Corrects useQuery's first overload @returns to match its actual return
type, moves the useSuspenseQuery/useSuspenseInfiniteQuery cancellation
caveat out of the @returns block, softens overstated skipToken/queryFn
claims, merges a duplicated useMutationState description, and adds
missing JSDoc to QueryErrorResetBoundary's function-type aliases and
UseMutateFunction/UseMutateAsyncFunction.
* docs(preact-query): soften remaining overstated queryFn requirement in Suspense options
* docs(preact-query): fix inaccurate prose in hydration, queryFn, and useQueries docs
* docs(preact-query): correct hydration freshness gate, placeholderData arity, and deprecated 'fetchInfiniteQuery' reference
* docs(preact-query): remove leftover 'data is never undefined' claim in 'useInfiniteQuery' overload docs
* docs(preact-query): replace deprecated 'prefetchQuery'/'prefetchInfiniteQuery' calls in examples with 'query'/'infiniteQuery'
* docs(preact-query): point 'usePrefetchQuery' JSDoc at 'queryClient.query' to match its actual option type
Currently there is a bug, which prevents proper rendering of the links if there are both MD & HTML syntax in the same line (see https://tanstack.com/query/latest/docs/framework/react/devtools), probably should be fixed in @tanstack/markdown. Not sure that the source code of this package is published?
In the meantime, I just converted all links to html.
Converting everything (logos) to markdown won't work because we need to set width/height, which can't be done in markdown
* docs(svelte): replace deprecated isLoading with isPending in overview
`isLoading` is a deprecated alias for `isPending && isFetching` and is
scheduled for removal in the next major version. The overview example
shows a standard (always-enabled) query, so `isPending` is the correct
flag. All other framework overview docs (React, Vue, Angular, Lit,
Preact) already use `isPending`.
Note: `isLoading` is intentionally retained in disabling-queries guides
where it is the right flag for disabled/lazy queries.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
* docs(preact): add missing polling guide
The Polling guide existed for React, Vue, Solid, and Angular but was
missing from the Preact docs. Added the ref stub and wired it into
the nav config between Window Focus Refetching and Disabling Queries,
matching the ordering used by all other frameworks.
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
---------
Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
* docs(devtools): replace framework-specific logo with 'TanStack logo' to match the actual rendered component
* docs(vue-query/devtools): replace 'React Query' panel leftover with 'Vue Query'
* docs(devtools): replace framework-specific logo with 'TanStack logo' and use adapter naming for 'devtools panel' in JSDoc
* docs(devtools): add missing 'relative' to JSDoc 'buttonPosition' union
* chore(.changeset): add changeset for devtools logo, panel, and 'buttonPosition' union alignment
* docs(preact-query-devtools): add missing 'position' union to JSDoc