Skip to content

Latest commit

 

History

History
 
 

clerk-js

README.md


@clerk/clerk-js

Overview

ClerkJS is our foundational JavaScript library for building user management and authentication. It enables you to register, sign in, verify and manage users for your application using highly customizable flows.

Getting Started

Installation

There are two ways you can include ClerkJS in your project. You can either import the ClerkJS npm module or load ClerkJS with a script tag.

Install ClerkJS as ES module

npm install @clerk/clerk-js

Once you have installed the package, you will need to import the ClerkJS object constructor into your code and pass it your Frontend API as a parameter.

import Clerk from '@clerk/clerk-js';

const clerkFrontendApi = 'clerk.[your-domain].com';
const clerk = new Clerk(clerkFrontendApi);
await clerk.load({
  // Set load options here...
});

Install ClerkJS as script

ClerkJS can be loaded from a <script /> tag with the source from your Frontend API URL.

Add the following script to your site's <body> element:

<script>
  // Get this URL from the Clerk Dashboard
  const frontendApi = 'clerk.[your-domain].com';
  const version = '@latest'; // Set to appropriate version

  // Creates asyncronous script
  const script = document.createElement('script');
  script.setAttribute('data-clerk-frontend-api', frontendApi);
  script.async = true;
  script.src = `https://${frontendApi}/npm/@clerk/clerk-js${version}/dist/clerk.browser.js`;

  // Adds listener to initialize ClerkJS after it's loaded
  script.addEventListener('load', async function () {
    await window.Clerk.load({
      // Set load options here...
    });
  });
  document.body.appendChild(script);
</script>

Build

To build the package locally with Webpack, run:

npm run build

Usage

<h1>Hello Clerk!</h1>

<button
  id="sign-in-button"
  onclick="Clerk.openSignIn()"
>
  Sign In
</button>
<div id="user-button"></div>

<script>
  async function loadClerk() {
    const userButton = document.getElementById('user-button');
    const signInButton = document.getElementById('sign-in-button');

    await window.Clerk.load();

    if (Clerk.user) {
      Clerk.mountUserButton(userButton);
      signInButton.hidden = true;
    }
  }
  // [...] Installation code
</script>

For further details and examples, please refer to our Documentation.

Support

You can get in touch with us in any of the following ways:

Contributing

We're open to all community contributions! If you'd like to contribute in any way, please read our contribution guidelines.

Security

@clerk/clerk-js follows good practices of security, but 100% security cannot be assured.

@clerk/clerk-js is provided "as is" without any warranty. Use at your own risk.

For more information and to report security issues, please refer to our security documentation.

License

This project is licensed under the MIT license.

See LICENSE for more information.