Skip to content

useClerk()

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

WARNING

This is intended to be used for advanced use cases, like building a completely custom OAuth flow or as an escape hatch for getting access to the Clerk object.

Returns

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

Usage

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

const clerk = useClerk()
</script>

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

Released under the MIT License.