useSignIn()
The useSignIn() composable provides access to the SignIn object, which allows you to check the current state of a sign-in attempt and manage the sign-in flow. You can use this to create a custom sign-in flow.
Returns
- Name
isLoaded- Type
Ref<boolean>- Description
A boolean that indicates whether Clerk has completed initialization. Initially
false, becomestrueonce Clerk loads.
- Name
setActive()- Type
Ref<(params: SetActiveParams) => Promise<void>>- Description
A function that sets the active session.
- Name
signIn- Type
Ref<SignIn>- Description
An object that contains the current sign-in attempt status and methods to create a new sign-in attempt.
How to use the useSignIn() composable
The following example uses useSignIn() to access the SignIn object, which contains the current sign-in attempt status and methods to create a new sign-in attempt. The isLoaded property is used to handle the loading state.
<script setup>
import { useSignIn } from '@clerk/vue'
const { isLoaded, signIn } = useSignIn()
</script>
<template>
<div v-if="!isLoaded">
<!-- Add logic to handle loading state -->
</div>
<div v-else>The current sign in attempt status is {{ signIn?.status }}.</div>
</template>Feedback
Last updated on