TanStack Start Quickstart (Beta)
You will learn the following:
- Install
@clerk/tanstack-start - Set your Clerk API keys
- Add
createClerkHandler() - Add
<ClerkProvider /> - Protect your pages
Learn how to use Clerk to quickly and easily add secure authentication and user management to your TanStack Start application.
Install @clerk/tanstack-start
Once you have a TanStack Start application ready, you need to install Clerk's TanStack Start SDK. This gives you access to Clerk's prebuilt components and hooks for TanStack Start applications.
Add the SDK to your project by running the following command:
npm install @clerk/tanstack-start@betayarn add @clerk/tanstack-start@betapnpm add @clerk/tanstack-start@betaVITE_CLERK_PUBLISHABLE_KEY=YOUR_PUBLISHABLE_KEY
CLERK_SECRET_KEY=YOUR_SECRET_KEYAdd createClerkHandler()
TanStack's createStartHandler() creates a server-side handler that determines which routes and loaders need to be executed when the user hits a given route.
Clerk's createClerkHandler() configures Clerk to handle authentication state for TanStack routes, allowing you to easily access user session information within your app.
Update your app's SSR entrypoint by wrapping createStartHandler() in createClerkHandler(), as shown in the following example:
import { createStartHandler, defaultStreamHandler } from '@tanstack/start/server'
import { getRouterManifest } from '@tanstack/start/router-manifest'
import { createRouter } from './router'
import { createClerkHandler } from '@clerk/tanstack-start/server'
export default createClerkHandler(
createStartHandler({
createRouter,
getRouterManifest,
}),
)(defaultStreamHandler)Add <ClerkProvider>
The <ClerkProvider> component wraps your application to provide active session and user context to Clerk's hooks and other components.
Add the <ClerkProvider> component to your app's root route, as shown in the following example:
import { Outlet, ScrollRestoration, createRootRoute } from '@tanstack/react-router'
import { Body, Head, Html, Meta, Scripts } from '@tanstack/start'
import * as React from 'react'
import { ClerkProvider } from '@clerk/tanstack-start'
export const Route = createRootRoute({
component: () => {
return (
<RootDocument>
<Outlet />
</RootDocument>
)
},
})
function RootDocument({ children }: { children: React.ReactNode }) {
return (
<ClerkProvider>
<Html>
<Head>
<Meta />
</Head>
<Body>
{children}
<ScrollRestoration />
<Scripts />
</Body>
</Html>
</ClerkProvider>
)
}Protect your pages
Client-side
To protect your pages on the client-side, you can use Clerk's prebuilt control components that control the visibility of content based on the user's authentication state.
The following example uses the following components:
<SignedIn>: Children of this component can only be seen while signed in.<SignedOut>: Children of this component can only be seen while signed out.<UserButton />: A prebuilt component that comes styled out of the box to show the avatar from the account the user is signed in with.<SignInButton />: An unstyled component that links to the sign-in page. For this example, it links to the Account Portal sign-in page.<SignUpButton />: An unstyled component that links to the sign-up page or displays the sign-up modal, depending on whichmodeyou have set. For this example, it links to the Account Portal sign-up page.
import {
SignedIn,
UserButton,
SignOutButton,
SignedOut,
SignInButton,
SignUpButton,
} from '@clerk/tanstack-start'
import { createFileRoute } from '@tanstack/react-router'
export const Route = createFileRoute('/')({
component: Home,
})
function Home() {
return (
<div>
<h1>Index Route</h1>
<SignedIn>
<p>You are signed in</p>
<UserButton />
<SignOutButton />
</SignedIn>
<SignedOut>
<p>You are signed out</p>
<SignInButton />
<SignUpButton />
</SignedOut>
</div>
)
}Server-side
To protect your routes, create a server function that checks the user's authentication state via Clerk's getAuth() method. If the user is not authenticated, they are redirected to a sign-in page. If authenticated, the user's userId is passed to the route, allowing access to the <Home /> component, which welcomes the user and displays their userId. The beforeLoad() method ensures authentication is checked before loading the page, and the loader() method returns the user data for use in the component.
import { createFileRoute, redirect } from '@tanstack/react-router'
import { createServerFn } from '@tanstack/start'
import { getAuth } from '@clerk/tanstack-start/server'
const authStateFn = createServerFn('GET', async (_, { request }) => {
const { userId } = await getAuth(request)
if (!userId) {
// This will error because you're redirecting to a path that doesn't exist yet
// You can create a sign-in route to handle this
throw redirect({
to: '/sign-in/$',
})
}
return { userId }
})
export const Route = createFileRoute('/')({
component: Home,
beforeLoad: async () => await authStateFn(),
loader: async ({ context }) => {
return { userId: context.userId }
},
})
function Home() {
const state = Route.useLoaderData()
return <h1>Welcome! Your ID is {state.userId}!</h1>
}Create your first user
Run your project with the following command:
npm run devyarn devpnpm devVisit your app's homepage at http://localhost:3000. Sign up to create your first user.
Create custom sign-up and sign-in pages
Learn how add custom sign-up and sign-in pages with Clerk components.
Read user and session data
Learn how to use Clerk's hooks and helpers to access the active session and user data in your TanStack Start application.
Customization & localization
Learn how to customize and localize the Clerk components.
Clerk components
Learn more about Clerk's prebuilt components.
Feedback
Last updated on