From 327380dc2f3b35f576e5a5586795ba80c6abde73 Mon Sep 17 00:00:00 2001 From: Michael Novotny Date: Tue, 22 Sep 2026 14:09:46 -0500 Subject: [PATCH] docs(react): note that @clerk/electron/react requires publishableKey Co-Authored-By: Claude Fable 5.1 --- .changeset/react-publishable-key-electron-jsdoc.md | 5 +++++ packages/react/src/types.ts | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) create mode 100644 .changeset/react-publishable-key-electron-jsdoc.md diff --git a/.changeset/react-publishable-key-electron-jsdoc.md b/.changeset/react-publishable-key-electron-jsdoc.md new file mode 100644 index 00000000000..18fb84e1320 --- /dev/null +++ b/.changeset/react-publishable-key-electron-jsdoc.md @@ -0,0 +1,5 @@ +--- +'@clerk/react': patch +--- + +Note in the `publishableKey` JSDoc that `@clerk/electron/react` requires it. diff --git a/packages/react/src/types.ts b/packages/react/src/types.ts index 204c05a1dd9..b392035abe7 100644 --- a/packages/react/src/types.ts +++ b/packages/react/src/types.ts @@ -53,7 +53,8 @@ export type ClerkProviderProps = Omit< children: React.ReactNode; /** * The Clerk Publishable Key for your instance. When omitted, `@clerk/react` reads the key from - * `VITE_CLERK_PUBLISHABLE_KEY` or `CLERK_PUBLISHABLE_KEY`. + * `VITE_CLERK_PUBLISHABLE_KEY` or `CLERK_PUBLISHABLE_KEY`. Required by `@clerk/electron/react`, + * which creates the Clerk instance for you. */ publishableKey?: string; /**