useUser()
The useUser() hook provides access to the current user's object, which contains all the data for a single user in your application and provides methods to manage their account. This hook also allows you to check if the user is signed in and if Clerk has loaded and initialized.
Returns
- Name
isLoaded- Type
false- Description
A boolean that indicates whether Clerk has completed initialization. Initially
false, becomestrueonce Clerk loads.
- Name
isSignedIn- Type
undefined- Description
A boolean that returns
trueif the user is signed in.
- Name
user- Type
undefined- Description
The
Userobject for the current user.
Example
Get the current user
The following example uses the useUser() hook to access the object, which contains the current user's data such as their full name. The isLoaded and isSignedIn properties are used to handle the loading state and to check if the user is signed in, respectively.
'use client'
import { useUser } from '@clerk/nextjs'
export default function Example() {
const { isSignedIn, user, isLoaded } = useUser()
if (!isLoaded) {
// Handle loading state
return <div>Loading...</div>
}
if (!isSignedIn) {
return <div>Sign in to view this page</div>
}
return <div>Hello {user.firstName}!</div>
}Update user data
The following example uses the useUser() hook to access the object, which calls the method to update the current user's information.
'use client'
import { useUser } from '@clerk/nextjs'
export default function HomePage() {
const { isSignedIn, isLoaded, user } = useUser()
if (!isLoaded) {
// Handle loading state
return null
}
if (!isSignedIn) return null
const updateUser = async () => {
await user.update({
firstName: 'John',
lastName: 'Doe',
})
}
return (
<>
<button onClick={updateUser}>Update your name</button>
<p>user.firstName: {user.firstName}</p>
<p>user.lastName: {user.lastName}</p>
</>
)
}Reload user data
The following example uses the useUser() hook to access the object, which calls the method to get the latest user's information.
'use client'
import { useUser } from '@clerk/nextjs'
export default function HomePage() {
const { isSignedIn, isLoaded, user } = useUser()
if (!isLoaded) {
// Handle loading state
return null
}
if (!isSignedIn) return null
const updateUser = async () => {
// Update data via an API endpoint
const updateMetadata = await fetch('/api/updateMetadata', {
method: 'POST',
body: JSON.stringify({
role: 'admin',
}),
})
// Check if the update was successful
if ((await updateMetadata.json()).message !== 'success') {
throw new Error('Error updating')
}
// If the update was successful, reload the user data
await user.reload()
}
return (
<>
<button onClick={updateUser}>Update your metadata</button>
<p>user role: {user.publicMetadata.role}</p>
</>
)
}Feedback
Last updated on