Skip to main content
Docs

useClerk()

Warning

This hook should only be used for advanced use cases, such as building a completely custom OAuth flow or as an escape hatch to access to the Clerk object.

The useClerk() hook provides access to the object, allowing you to build alternatives to any Clerk Component.

Returns

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

Example

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

src/Home.tsx
import { useClerk } from "@clerk/clerk-react";

export default function Home() {
  const clerk = useClerk();

  return <button onClick={() => clerk.openSignIn({})}>Sign in</button>;
}
app/page.tsx
"use client";

import { useClerk } from "@clerk/nextjs";

export default function HomePage() {
  const clerk = useClerk();

  return <button onClick={() => clerk.openSignIn({})}>Sign in</button>;
}

Feedback

What did you think of this content?
GitHubEdit on GitHub

Last updated on