useSessionList()
The useSessionList() hook returns an array of Session objects that have been registered on the client device.
Returns
This function returns a discriminated union type. There are multiple variants of this type available which you can select by clicking on one of the tabs.
- Name
isLoaded- Type
false- Description
A boolean that indicates whether Clerk has completed initialization. Initially
false, becomestrueonce Clerk loads.
- Name
sessions- Type
undefined- Description
A list of sessions that have been registered on the client device.
- Name
setActive- Type
undefined- Description
A function that sets the active session and/or organization.
- Name
isLoaded- Type
true- Description
A boolean that indicates whether Clerk has completed initialization. Initially
false, becomestrueonce Clerk loads.
- Name
sessions- Type
SessionResource[]- Description
A list of sessions that have been registered on the client device.
- Name
setActive()- Type
(setActiveParams) => Promise<void>- Description
A function that sets the active session and/or organization.
Example
Get a list of sessions
The following example uses useSessionList() to get a list of sessions that have been registered on the client device. The sessions property is used to show the number of times the user has visited the page.
import { useSessionList } from "@clerk/clerk-react";
export default function Home() {
const { isLoaded, sessions } = useSessionList();
if (!isLoaded) {
// Handle loading state
return null;
}
return (
<div>
<p>Welcome back. You've been here {sessions.length} times before.</p>
</div>
);
}"use client";
import { useSessionList } from "@clerk/nextjs";
export default function HomePage() {
const { isLoaded, sessions } = useSessionList();
if (!isLoaded) {
// Handle loading state
return null;
}
return (
<div>
<p>Welcome back. You've been here {sessions.length} times before.</p>
</div>
);
}Feedback
Last updated on