function useInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): DefinedUseInfiniteQueryResult<TData, TError>;
function useInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): UseInfiniteQueryResult<TData, TError>;See also: Parameters · Returns
function useInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options: DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): DefinedUseInfiniteQueryResult<TData, TError>;Defined in: packages/solid-query/src/useInfiniteQuery.ts:68
The options for useInfiniteQuery are identical to useQuery, with the addition of initialPageParam, getNextPageParam, getPreviousPageParam, and maxPages.
This overload is selected when initialData is set.
TQueryFnData
TError = Error
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = unknown
DefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
An accessor returning the DefinedInitialDataInfiniteOptions to use — everything you can pass to useInfiniteQuery, with initialData set.
Accessor<QueryClient>
An accessor for a custom QueryClient. Otherwise, the one from the nearest context will be used.
DefinedUseInfiniteQueryResult<TData, TError>
The same properties as useQuery, with the addition of fetchNextPage, fetchPreviousPage, hasNextPage, hasPreviousPage, isFetchingNextPage, and isFetchingPreviousPage. data.pages and data.pageParams are also added, as long as a select doesn't change TData away from its default InfiniteData<TQueryFnData> shape.
Keep in mind that imperative fetch calls, such as fetchNextPage, may interfere with the default refetch behavior, resulting in outdated data. Make sure to call these functions only in response to user actions, or add conditions like hasNextPage && !isFetching.
infiniteQueryOptions to share these options between useInfiniteQuery and imperative APIs like queryClient.infiniteQuery.
import { For } from 'solid-js'
import { useInfiniteQuery } from '@tanstack/solid-query'
function Projects() {
// `projectsQuery.data` is never `undefined`, thanks to `initialData` — even if a refetch fails, so the
// list stays visible alongside the error.
const projectsQuery = useInfiniteQuery(() => ({
queryKey: ['projects'],
queryFn: ({ pageParam }) => fetchProjects(pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextId,
initialData: { pages: [], pageParams: [] },
}))
return (
<div>
{projectsQuery.isError ? <span>Error: {projectsQuery.error.message}</span> : null}
<ul>
<For each={projectsQuery.data.pages}>
{(page) => <For each={page.projects}>{(p) => <li>{p.name}</li>}</For>}
</For>
</ul>
</div>
)
}function useInfiniteQuery<TQueryFnData, TError, TData, TQueryKey, TPageParam>(options: UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>, queryClient?: Accessor<QueryClient>): UseInfiniteQueryResult<TData, TError>;Defined in: packages/solid-query/src/useInfiniteQuery.ts:184
The options for useInfiniteQuery are identical to useQuery, with the addition of initialPageParam, getNextPageParam, getPreviousPageParam, and maxPages.
TQueryFnData
TError = Error
TData = InfiniteData<TQueryFnData, unknown>
TQueryKey extends readonly unknown[] = readonly unknown[]
TPageParam = unknown
UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
An accessor returning the UndefinedInitialDataInfiniteOptions to use — everything you can pass to useInfiniteQuery.
Accessor<QueryClient>
An accessor for a custom QueryClient. Otherwise, the one from the nearest context will be used.
UseInfiniteQueryResult<TData, TError>
The same properties as useQuery, with the addition of fetchNextPage, fetchPreviousPage, hasNextPage, hasPreviousPage, isFetchingNextPage, and isFetchingPreviousPage. data.pages and data.pageParams are also added, as long as a select doesn't change TData away from its default InfiniteData<TQueryFnData> shape.
Keep in mind that imperative fetch calls, such as fetchNextPage, may interfere with the default refetch behavior, resulting in outdated data. Make sure to call these functions only in response to user actions, or add conditions like hasNextPage && !isFetching.
infiniteQueryOptions to share these options between useInfiniteQuery and imperative APIs like queryClient.infiniteQuery.
Fetching the next page from a "Load More" button click:
import { For, Match, Switch } from 'solid-js'
import { useInfiniteQuery } from '@tanstack/solid-query'
function Projects() {
const projectsQuery = useInfiniteQuery(() => ({
queryKey: ['projects'],
queryFn: ({ pageParam }) => fetchProjects(pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextId,
}))
return (
<Switch>
<Match when={projectsQuery.isPending}>Loading...</Match>
<Match when={projectsQuery.isError}>Error: {projectsQuery.error.message}</Match>
<Match when={projectsQuery.isSuccess}>
<ul>
<For each={projectsQuery.data.pages}>
{(page) => <For each={page.projects}>{(p) => <li>{p.name}</li>}</For>}
</For>
</ul>
<button
onClick={() => projectsQuery.fetchNextPage()}
disabled={!projectsQuery.hasNextPage || projectsQuery.isFetching}
>
{projectsQuery.isFetchingNextPage
? 'Loading more...'
: projectsQuery.hasNextPage
? 'Load More'
: 'Nothing more to load'}
</button>
</Match>
</Switch>
)
}Fetching the next page automatically as the user scrolls, using an IntersectionObserver on a sentinel element after the list:
import { For, Match, Switch, createEffect, onCleanup } from 'solid-js'
import { useInfiniteQuery } from '@tanstack/solid-query'
function Projects() {
const projectsQuery = useInfiniteQuery(() => ({
queryKey: ['projects'],
queryFn: ({ pageParam }) => fetchProjects(pageParam),
initialPageParam: 0,
getNextPageParam: (lastPage) => lastPage.nextId,
}))
let sentinelRef: HTMLDivElement | undefined
createEffect(() => {
if (sentinelRef == null || !projectsQuery.hasNextPage || projectsQuery.isFetching) return
const observer = new IntersectionObserver(([entry]) => {
if (entry?.isIntersecting) projectsQuery.fetchNextPage()
})
observer.observe(sentinelRef)
onCleanup(() => observer.disconnect())
})
return (
<Switch>
<Match when={projectsQuery.isPending}>Loading...</Match>
<Match when={projectsQuery.isError}>Error: {projectsQuery.error.message}</Match>
<Match when={projectsQuery.isSuccess}>
<ul>
<For each={projectsQuery.data.pages}>
{(page) => <For each={page.projects}>{(p) => <li>{p.name}</li>}</For>}
</For>
</ul>
<div ref={sentinelRef}>{projectsQuery.isFetchingNextPage ? 'Loading more...' : null}</div>
</Match>
</Switch>
)
}UndefinedInitialDataInfiniteOptions<TQueryFnData, TError, TData, TQueryKey, TPageParam>
An accessor returning the UndefinedInitialDataInfiniteOptions to use — everything you can pass to useInfiniteQuery.
Built from InfiniteQueryOptions. See the type above for what it changes.
Accessor<QueryClient>
An accessor for a custom QueryClient. Otherwise, the one from the nearest context will be used.
UseInfiniteQueryResult<TData, TError>
The same properties as useQuery, with the addition of fetchNextPage, fetchPreviousPage, hasNextPage, hasPreviousPage, isFetchingNextPage, and isFetchingPreviousPage. data.pages and data.pageParams are also added, as long as a select doesn't change TData away from its default InfiniteData<TQueryFnData> shape.
| Property | Type | Description |
|---|---|---|
| data | TData | undefined | The last successfully resolved data for the query. |
| dataUpdatedAt | number | The timestamp for when the query most recently returned the status as "success". |
| error | TError | null | The error object for the query, if an error was thrown. - Defaults to null. |
| errorUpdateCount | number | The sum of all errors. |
| errorUpdatedAt | number | The timestamp for when the query most recently returned the status as "error". |
| failureCount | number | The failure count for the query. - Incremented every time the query fails. - Reset to 0 when the query succeeds. |
| failureReason | TError | null | The failure reason for the query retry. - Reset to null when the query succeeds. |
| fetchNextPage | (options?: FetchNextPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>> | This function allows you to fetch the next "page" of results. |
| fetchPreviousPage | (options?: FetchPreviousPageOptions) => Promise<InfiniteQueryObserverResult<TData, TError>> | This function allows you to fetch the previous "page" of results. |
| fetchStatus | "fetching" | "paused" | "idle" | The fetch status of the query. - fetching: Is true whenever the queryFn is executing, which includes initial pending as well as background refetch. - paused: The query wanted to fetch, but has been paused. - idle: The query is not fetching. - See Network Mode for more information. |
| hasNextPage | boolean | Will be true if there is a next page to be fetched (known via the getNextPageParam option). |
| hasPreviousPage | boolean | Will be true if there is a previous page to be fetched (known via the getPreviousPageParam option). |
| isEnabled | boolean | true if this observer is enabled, false otherwise. |
| isError | boolean | A derived boolean from the status variable, provided for convenience. - true if the query attempt resulted in an error. |
| isFetched | boolean | Will be true if the query has been fetched. |
| isFetchedAfterMount | boolean | Will be true if the query has been fetched after the component mounted. - This property can be used to not show any previously cached data. |
| isFetching | boolean | A derived boolean from the fetchStatus variable, provided for convenience. - true whenever the queryFn is executing, which includes initial pending as well as background refetch. |
| isFetchingNextPage | boolean | Will be true while fetching the next page with fetchNextPage. |
| isFetchingPreviousPage | boolean | Will be true while fetching the previous page with fetchPreviousPage. |
| isFetchNextPageError | boolean | Will be true if the query failed while fetching the next page. |
| isFetchPreviousPageError | boolean | Will be true if the query failed while fetching the previous page. |
| | boolean | Deprecated isInitialLoading is being deprecated in favor of isLoading and will be removed in the next major version. |
| isLoading | boolean | Is true whenever the first fetch for a query is in-flight. - Is the same as isFetching && isPending. |
| isLoadingError | boolean | Will be true if the query failed while fetching for the first time. |
| isPaused | boolean | A derived boolean from the fetchStatus variable, provided for convenience. - The query wanted to fetch, but has been paused. |
| isPending | boolean | Will be pending if there's no cached data and no query attempt was finished yet. |
| isPlaceholderData | boolean | Will be true if the data shown is the placeholder data. |
| isRefetchError | boolean | Will be true if the query failed while refetching. |
| isRefetching | boolean | Is true whenever a background refetch is in-flight, which does not include initial pending. - Is the same as isFetching && !isPending. |
| isStale | boolean | Will be true if the data in the cache is invalidated or if the data is older than the given staleTime. |
| isSuccess | boolean | A derived boolean from the status variable, provided for convenience. - true if the query has received a response with no errors and is ready to display its data. |
| refetch | (options?: RefetchOptions) => Promise<QueryObserverResult<TData, TError>> | A function to manually refetch the query. |
| status | "error" | "pending" | "success" | The status of the query. - Will be: - pending if there's no cached data and no query attempt was finished yet. - error if the query attempt resulted in an error. - success if the query has received a response with no errors and is ready to display its data. |