useClerk() | Vue

The useClerk() composable provides access to the Clerk object, giving you the ability to build alternatives to any Clerk component.

Returns

The useClerk() composable returns the Clerk object, which includes all the methods and properties listed in the Clerk reference.

How to use the useClerk() composable

The following example uses the useClerk() composable to access the clerk object. The clerk object is used to call the openSignIn() method to open the sign-in modal.

<script setup>
import { useClerk } from '@clerk/vue'

const clerk = useClerk()
</script>

<template>
  <button @click="clerk.openSignIn">Sign in</button>
</template>