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.

1
User 1052/14/26, 2:17 PM

hello Emma, how's the weather in SF?

8
User 8752/14/26, 2:17 PM

hey James- how's the weather in SF?

7
User 7732/14/26, 2:17 PM

hey Emma; Could you let the customer know we've fixed their issue?

8
User 8772/14/26, 2:17 PM

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

6
User 6132/14/26, 2:17 PM

Hi Jamie... I'll be late to make the meeting tomorrow morning

4
User 4392/14/26, 2:17 PM

hey James... I'll be late to make the meeting tomorrow morning

3
User 3042/14/26, 2:17 PM

hello James, how was your weekend?

9
User 9062/14/26, 2:17 PM

hello James... I'll be late to make the meeting tomorrow morning

8
User 8282/14/26, 2:17 PM

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

3
User 3472/14/26, 2:17 PM

Hi Jamie, how's the weather in SF?

7
User 7902/14/26, 2:17 PM

hello Jamie; how was your weekend?

2
User 2022/12/26, 10:12 AM

Hi Nipunn; how was your weekend?

4
User 4332/12/26, 10:12 AM

Hi Emma- how was your weekend?

2
User 2782/12/26, 10:12 AM

hey Jamie; Could you let the customer know we've fixed their issue?

3
User 3912/12/26, 10:12 AM

Hi Jamie! I'll be late to make the meeting tomorrow morning

8
User 8552/12/26, 10:12 AM

hi Emma- I'll be late to make the meeting tomorrow morning

3
User 3592/12/26, 10:12 AM

hey Jamie- how's the weather in SF?

8
User 8142/12/26, 10:12 AM

hey Jamie; how was your weekend?

1
User 1982/12/26, 10:12 AM

hello Emma, what's your favorite ice cream place?

1
User 1702/12/26, 10:12 AM

hello James- how was your weekend?

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