npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@clerk/clerk-js

v5.1.1

Published

Clerk JS library

Downloads

73,285

Readme

@clerk/clerk-js

Chat on Discord Clerk documentation Follow on Twitter

Changelog · Report a Bug · Request a Feature · Ask a Question


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 Publishable Key as a parameter.

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

const clerkPublishableKey = 'pk_[publishable_key]';
const clerk = new Clerk(clerkPublishableKey);
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 and Publishable Key from the Clerk Dashboard
  const clerkPublishableKey = 'pk_[publishable_key]';
  const frontendApiUrl = '[your-domain].clerk.accounts.dev';
  const version = '@latest'; // Set to appropriate version

  // Creates asynchronous script
  const script = document.createElement('script');
  script.setAttribute('data-clerk-publishable-key', clerkPublishableKey);
  script.async = true;
  script.src = `https://${frontendApiUrl}/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.