Convex with TanStack Start

Loaders and Prefetching

TanStack Start routes can have isomorphic loader functions that run on the server for the initial pageload and on the client for subsequent client-side navigations.

These three links navigate to subpages that show chat messages from different channels. Notice how client navigations between these pages work differently.

Awaiting ensureQueryData will block rendering of the page until that data is available and calling prefetchQuery will start the request but not block. Loaders also run during prefetching, triggered by the cursor mousing onto a link in TanStack Start by default.

When to use a loader

Loading a query in a loader ejects from the convenience of component-local reasoning through useSuspenseQuery where a component fetching its own data to the cold reality of fast page loads when you need it.

1
User 197012/1/24, 12:32 PM

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

9
User 924411/28/24, 11:37 PM

hey Emma! I'll be late to make the meeting tomorrow morning

7
User 773911/17/24, 7:19 AM

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

3
User 339111/17/24, 3:08 AM

hey Emma- how was your weekend?

4
User 426611/14/24, 10:46 AM

hello Emma! how was your weekend?

4
User 426611/14/24, 10:46 AM

hi Nipunn... Could you let the customer know we've fixed their issue?

4
User 426611/14/24, 10:45 AM

Hi Emma... what's your favorite ice cream place?

1
User 124711/14/24, 10:36 AM

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

9
User 989511/14/24, 10:36 AM

hello Jamie! how's the weather in SF?

1export const Route = createFileRoute('/loaders/ensure')({
2  loader: async (opts) => {
3    await opts.context.queryClient.ensureQueryData(
4      convexQuery(api.messages.list, {}),
5    );
6  },
7  component: () => {
8    const { data } = useSuspenseQuery(
9      convexQuery(api.messages.list, {})
10    );
11  },
12})

Learn More

Tanner's An Early Glimpse of TanStack Start video

TanStack Router Preloading Guide