Skip to main content
Docs

useSignUp() | Vue

The useSignUp() composable provides access to the object, which allows you to check the current state of a sign-up attempt and manage the sign-up flow. You can use this to create a custom sign-up flow.

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: ) => Promise<void>>
    Description

    A function that sets the active session.

  • Name
    signUp
    Type
    Ref<>
    Description

    An object that contains the current sign-up attempt status and methods to create a new sign-up attempt.

How to use the useSignUp() composable

Check the current state of a sign-up

The following example uses the useSignUp() hook to access the object, which contains the current sign-up attempt status and methods to create a new sign-up attempt. The isLoaded property is used to handle the loading state.

SignUpStep.vue
<script setup>
import { useSignUp } from '@clerk/vue'

const { isLoaded, signUp } = useSignUp()
</script>

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

  <div v-else>The current sign-up attempt status is {{ signUp?.status }}.</div>
</template>

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on