useSignIn()

Returns
Examples
1. Check the current state of a sign-in
2. Create a custom sign-in flow with useSignIn()

Available in other SDKs

The useSignIn() hook provides access to the SignIn object, which allows you to check the current state of a sign-in attempt and manage the sign-in flow. You can use this to create a custom sign-in flow.

Returns

There are multiple variants of this type available which you can select by clicking on one of the tabs.

Initialization

Loaded

Name
isLoaded
Type
false
Description
A boolean that indicates whether Clerk has completed initialization. Initially false, becomes true once Clerk loads.
Name
setActive
Type
undefined
Description
A function that sets the active session. See the reference doc.
Name
signIn
Type
undefined
Description
An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.

Name
isLoaded
Type
true
Description
A boolean that indicates whether Clerk has completed initialization. Initially false, becomes true once Clerk loads.
Name
setActive()
Type
(setActiveParams: SetActiveParams) => Promise<void>
Description
A function that sets the active session. See the reference doc.
Name
signIn
Type
SignInResource
Description
An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.

Examples

The following example uses the useSignIn() hook to access the SignIn object, which contains the current sign-in attempt status and methods to create a new sign-in attempt. The isLoaded property is used to handle the loading state.

app/routes/index.tsx

import { useSignIn } from '@clerk/tanstack-react-start'
import { createFileRoute } from '@tanstack/react-router'

export const Route = createFileRoute('/')({
  component: SignInPage,
})

export default function SignInPage() {
  const { isLoaded, signIn } = useSignIn()

  // Handle loading state
  if (!isLoaded) return <div>Loading...</div>

  return <div>The current sign-in attempt status is {signIn?.status}.</div>
}

The useSignIn() hook can also be used to build fully custom sign-in flows, if Clerk's prebuilt components don't meet your specific needs or if you require more control over the authentication flow. Different sign-in flows include email and password, email and phone codes, email links, and multifactor (MFA). To learn more about using the useSignIn() hook to create custom flows, see the custom flow guides.

Last updated on Feb 13, 2026

Edit on GitHub

useSignIn()

Returns

Examples

Check the current state of a sign-in

Create a custom sign-in flow with useSignIn()

Feedback

Create a custom sign-in flow with `useSignIn()`