Skip to main content
Docs

useSessionList()

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

Returns

  • Name
    isLoaded
    Type
    Ref<boolean>
    Description

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

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

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

  • Name
    sessions
    Type
    Ref<Session>
    Description

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

How to use the useSessionList() composable

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.

SessionList.vue
<script setup>
import { useSessionList } from '@clerk/vue'

const { isLoaded, sessions } = useSessionList()
</script>

<template>
  <div v-if="!isLoaded">
    <!-- Handle loading state -->
  </div>

  <div v-else>
    <p>Welcome back. You've been here {{ sessions.length }} times before.</p>
  </div>
</template>

Feedback

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

Last updated on