useSignIn()
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
- Name
isLoaded- Type
boolean- Description
A boolean that indicates whether Clerk has completed initialization. Initially
false, becomestrueonce Clerk loads.
- Name
setActive()- Type
(params: SetActiveParams) => Promise<void>- Description
A function that sets the active session.
- Name
signIn- Type
SignIn- Description
An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.
How to use the useSignIn() hook
Check the current state of a sign-in
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.
import { useSignIn } from '@clerk/clerk-react'
export default function SignInPage() {
const { isLoaded, signIn } = useSignIn()
if (!isLoaded) {
// Handle loading state
return null
}
return <div>The current sign-in attempt status is {signIn?.status}.</div>
}'use client'
import { useSignIn } from '@clerk/nextjs'
export default function SignInPage() {
const { isLoaded, signIn } = useSignIn()
if (!isLoaded) {
// Handle loading state
return null
}
return <div>The current sign-in attempt status is {signIn?.status}.</div>
}Create a custom sign-in flow with useSignIn()
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.
Feedback
Last updated on