Convex with TanStack Start

Using React Query hooks for data from Convex

TanStack Start apps can use React Query (TanStack Query for React) hooks to take advantage of React Query's excellent Start integration. Convex queries are exposed through query options factories like convexQuery().

Instead of React Query's standard interval and activity-based polling and manual invalidation, updates are streamed down WebSocket to update the Query Cache directly for live, always-up-to-date results.

Open this page in another tab or on your phone and send a message or to see these updates pushed live.

3
User 333910/15/25, 8:16 AM

hi Jamie- how was your weekend?

4
User 407510/13/25, 1:38 PM

hey Emma, how's the weather in SF?

6
User 677810/13/25, 1:14 PM

hey Nipunn- how was your weekend?

6
User 677810/13/25, 1:14 PM

Hi Nipunn; how was your weekend?

6
User 677810/13/25, 1:14 PM

hi Nipunn, I'll be late to make the meeting tomorrow morning

5
User 53510/13/25, 1:07 PM

Hi Jamie; how's the weather in SF?

9
User 94810/13/25, 1:07 PM

hey Jamie... how's the weather in SF?

7
User 73410/13/25, 1:07 PM

hey Emma- what's your favorite ice cream place?

9
User 9210/13/25, 1:07 PM

Hi Nipunn! Could you let the customer know we've fixed their issue?

1
User 16910/13/25, 1:07 PM

hi Jamie... how was your weekend?

2
User 27510/13/25, 1:07 PM

hello Emma, I'll be late to make the meeting tomorrow morning

4
User 45110/13/25, 1:07 PM

hi Nipunn- how was your weekend?

1
User 14110/13/25, 1:07 PM

hey Jamie! what's your favorite ice cream place?

3
User 33910/13/25, 1:07 PM

hello Emma! how was your weekend?

8
User 89910/13/25, 1:07 PM

Hi Jamie! Could you let the customer know we've fixed their issue?

8
User 80410/13/25, 1:07 PM

hello Jamie; how's the weather in SF?

4
User 49310/13/25, 1:07 PM

hi James! I'll be late to make the meeting tomorrow morning

3
User 38910/13/25, 1:07 PM

hi Jamie! how's the weather in SF?

9
User 94010/13/25, 1:07 PM

hello Nipunn, Could you let the customer know we've fixed their issue?

5
User 58210/13/25, 1:07 PM

hey James; what's your favorite ice cream place?

1import { useQuery } from "@tanstack/react-query";
2import { convexQuery } from "@convex-dev/react-query";
3import { api } from "../convex/_generated/api";
4

5const messagesQuery = convexQuery(
6  api.messages.listMessages,
7  { channel: "chatty" }
8)
9

10// inside a React component
11const { data, isPending } = useQuery(messagesQuery);
12

13// in an event handler, useEffect, or loader
14queryClient.prefetchQuery(messagesQuery);
15

16// adding more query options to convexQuery()
17const { data } = useQuery({
18  ...convexQuery(api.messages.listMessages, {}),
19  initialData: [],
20  gcTime: 10000,
21});

Already used Convex React hooks?

If you've used Convex React hooks React Query hooks are going to familiar. Instead of returning the data directly, this useQuery() returns an object with a .data property along with other metadata. The hook accepts a single object, which you'll mostly populate with the return value of the convexQuery() hook.

The same React Query hooks can be used for fetch endpoints and Convex actions for standard interval or activity-based polling while Convex queries benefit from the live update behavior.

What does this give you? It's not just the often-asked-for isLoading and error properties or simple interop with other server endpoints or introspection from the TanStack Query devtools. It's React Query's Router integration with the TanStack Start providing things like server-side rendering and live updating queries in a single hook.

Learn More

TanStack Query (AKA React Query) docs

Using TanStack Query with Convex

The @convex-dev/react-query library links the TanStack Query Client with the Convex client