Skip to main content
Docs
Dashboard

useSessionList()

The useSessionList() hook returns an array of Session objects that have been registered on the client device.

Returns

  • Name
    isLoaded
    Type
    boolean
    Description

    A boolean that indicates whether Clerk has completed initialization. Initially false, becomes true once Clerk loads.

  • Name
    setActive()
    Type
    (params: SetActiveParams) => Promise<void>
    Description

    A function that sets the active session and/or organization.

  • Name
    sessions
    Type
    Session[]
    Description

    A list of sessions that have been registered on the client device.

How to use the useSessionList() hook

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.

src/Home.tsx
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>
  )
}
app/page.tsx
'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

What did you think of this content?
Edit this page on GitHub

Last updated on