@clerk/clerk-js

clerk-js

Clerk JS library

Table of Contents

• ☀️ Introduction
• 📘 Official documentation
• 🔥 Versioning & hotloading
• 🚢 Release

☀️ Introduction

@clerk/clerk-js contains the Clerk UI authentication components and the window.Clerk object.

Available UI components:

• Sign in
• Sign up
• User button
• User profile

The window.Clerk object handles the communication with the Client API, stores and mutates the current client and session data and controls the UI components rendering.

🚢 Release

Staging

In @clerk/clerk-js staging releases we use npm-dist-tags. That way, staging deployments don't affect the latest production release.

⚠️ Note: Due to a Yarn open bug npm lifecycle scripts are not invoked while working with workspaces. So you should invoke them explicitly as shown below.

yarn workspace @clerk/clerk-js prepublish &&
yarn workspace @clerk/clerk-js npm publish --tag staging

Production

In @clerk/clerk-js production releases, *verify that the package.json version is bumped and then execute the following instructions.

⚠️ Note: Due to a Yarn open bug npm lifecycle scripts are not invoked while working with workspaces. So you should invoke them explicitly as shown below.

yarn workspace @clerk/clerk-js prepublish &&
yarn workspace @clerk/clerk-js npm publish