loading…Loading
inspect hooks/*
Every Clerk React hook and what it returns. Expand any row to inspect its current output. Signed out, you see the empty signed-out shape; sign in and the same rows fill with your real session, user, and organization data.
useUser()current userinspectThe current user's profile, emails, phones, image, and metadata, plus loading and signed-in state.
{
"isLoaded": false,
"user": null
}useAuth()auth state + tokensinspectAuthentication state and helpers: user/session/org ids, role and slug, plus has(), getToken(), and signOut().
{
"isLoaded": false,
"has": "fn()",
"getToken": "fn()",
"signOut": "fn()"
}useClerk()clerk instanceinspectThe Clerk singleton: open* modal helpers, setActive, navigate, and the live user/session/organization objects.
{
"loaded": false,
"user": null,
"session": null,
"organization": null,
"availableMethods": {
"openSignIn": true,
"openSignUp": true,
"openUserProfile": true,
"openOrganizationProfile": true,
"openCreateOrganization": true,
"setActive": true,
"signOut": true,
"navigate": true
}
}useSession()current sessioninspectThe active session: id, status, activity, and expiry, plus end(), getToken(), and reload().
{
"isLoaded": false,
"session": null
}useSessionList()session listinspectAll sessions for the current user, for multi-session apps and session switching.
{
"isLoaded": false,
"sessions": [],
"setActive": "unavailable"
}useOrganization()active organizationinspectThe active organization and your membership in it, for multi-tenant apps.
{
"isLoaded": false,
"organization": null,
"membership": null
}useOrganizationList()organization listinspectOrganizations you belong to or are invited to, with setActive and createOrganization.
{
"isLoaded": false,
"userMemberships": [],
"userInvitations": [],
"setActive": "unavailable",
"createOrganization": "unavailable"
}useSignIn()sign-in flowinspectState for building a custom sign-in flow: supported factors, identifiers, and verification status.
{
"isLoaded": false,
"setActive": "unavailable",
"signIn": null
}useSignUp()sign-up flowinspectState for building a custom sign-up flow: required and unverified fields, verifications, and status.
{
"isLoaded": false,
"signUp": null,
"setActive": "unavailable"
}These hooks give reactive access to Clerk auth state and user data. They re-render automatically when the underlying data changes, and are fully typed.
why
where you'd use them