Clerk Hooks
- useSignUp()
- useSignIn()
- useClerk()
- useAuth()
- useUser()
- useSession()
- useOrganization()
- useOrganizationList()
- useSocialAuthFlow()
- useSignUpFlow()
- useSignInFlow()
Universal Clerk Hooks
The core Clerk hooks are re-exported from a single universal entry point so you can import them the same way on Web (Next.js) and Mobile (Expo). Under the hood, we proxy to @clerk/nextjs
on web and @clerk/clerk-expo
on mobile.
useAuth()
Read auth state (isSignedIn, org, session) and perform auth actions. (Docs)
import { useAuth } from '@auth/clerk'
useUser()
Access the current Clerk user object and basic profile data. (Docs)
import { useUser } from '@auth/clerk'
useSession()
Access the active session and session-related helpers. (Docs)
import { useSession } from '@auth/clerk'
useClerk()
Low-level Clerk instance for advanced interactions. (Docs)
import { useClerk } from '@auth/clerk'
useOrganization()
The active organization context (if organizations are enabled). (Docs)
import { useOrganization } from '@auth/clerk'
useSignIn()
Low-level Clerk sign-in resource. Prefer useSignInFlow()
for a batteries-included flow. (Docs)
import { useSignIn } from '@auth/clerk'
useSignUp()
Low-level Clerk sign-up resource. Prefer useSignUpFlow()
for verification + form state. (Docs)
import { useSignUp } from '@auth/clerk'
useOrganizationList()
Access a user’s organizations and set the active organization. (Docs)
import { useOrganizationList } from '@auth/clerk'
New Universal Hooks
Consider these hooks upgrades from the original useSignUp()
and useSignIn()
hooks by Clerk. They contain more logic and form state to build custom sign up and sign in flows with.
useSignUpFlow()
import { useSignUpFlow } from '@auth/clerk'
Helps you build a custom sign up flow. (Docs)
useSignInFlow()
import { useSignInFlow } from '@auth/clerk/hooks/useSignInFlow'
Helps you build a custom sign in flow. (Docs)
New Expo Hooks
useSocialAuthFlow()
import { useSocialAuthFlow } from '@auth/clerk/hooks/useSocialAuthFlow'
Helps you build a custom social auth flow. (Docs)