docs(react): note that @clerk/electron/react requires publishableKey

[manovotny]

Description

The shared ClerkProviderProps JSDoc for publishableKey says the prop is optional because @clerk/react can read it from the environment. @clerk/electron/react re-exports that provider but creates the Clerk instance itself, so the prop is required there. One sentence in the JSDoc says so, which lets the generated docs (https://github.com/clerk/clerk/pull/3382) stop duplicating the prop in an Electron-specific block.

Changeset: @clerk/react patch.

Checklist

• pnpm test runs as expected.
• pnpm build runs as expected.
• Documentation has been updated (the generated TypeDoc in clerk/clerk#3382 carries the same sentence).

Type of change

• 📝 Documentation update

🤖 Generated with Claude Code

[vercel]

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Actions	Updated
clerk-js-sandbox	Ready	Preview	Sep 22, 2026 7:12pm UTC
swingset	Ready	Preview	Sep 22, 2026 7:12pm UTC

[changeset-bot]

🦋 Changeset detected

Latest commit: 327380d

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 8 packages

Name	Type
@clerk/react	Patch
@clerk/chrome-extension	Patch
@clerk/electron	Patch
@clerk/expo	Patch
@clerk/nextjs	Patch
@clerk/react-router	Patch
@clerk/tanstack-react-start	Patch
@clerk/swingset	Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

[coderabbitai]

Navigate logical layers of code changes, visualize relationships, and explore their blast radius.

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Repository YAML (base), Organization UI (inherited)

Review profile: ASSERTIVE

Plan: Team

Run ID: 3fb4a981-954b-4585-a52d-afb9adb02ee7

📥 Commits

Reviewing files that changed from the base of the PR and between 10d6603 and 327380d.

📒 Files selected for processing (2)

• .changeset/react-publishable-key-electron-jsdoc.md
• packages/react/src/types.ts

🔗 Linked repositories identified

CodeRabbit considers these linked repositories for cross-repo context during reviews:

• clerk/clerk_go (manual)
• clerk/dashboard (manual)
• clerk/accounts (manual)
• clerk/backoffice (manual)
• clerk/clerk (manual) → reviewed against open PR #3382 manovotny/docs-11976-js-plan-4e90a9 instead of the default branch
• clerk/clerk-docs (manual)
• clerk/cloudflare-workers (manual)
• clerk/cli (auto-detected)
• clerk/clerk-ios (auto-detected)
• clerk/clerk-android (auto-detected)

Included review availability: 4 reviews are currently available. Your included PR review attempts over the past 7 days set your current allowance at 8 reviews per hour.

---

📝 Walkthrough

Walkthrough

The ClerkProviderProps.publishableKey documentation now states that @clerk/electron/react requires the key because it creates the Clerk instance automatically. A patch changeset records this documentation update for @clerk/react.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Suggested reviewers: sarahsoutoul

Merge Risk: ⚪ Minimal · up to 32738

This documentation-only update is mergeable with no identified production risk.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the main documentation change: noting that @clerk/electron/react requires publishableKey.
Description check	✅ Passed	The description accurately explains the JSDoc update, the Electron React requirement, the generated documentation purpose, and the changeset.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 1…
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

---

_{Comment @coderabbitai help to get the list of available commands.}

[pkg-pr-new]

Open in StackBlitz

@clerk/astro

npm i https://pkg.pr.new/@clerk/astro@9867

@clerk/backend

npm i https://pkg.pr.new/@clerk/backend@9867

@clerk/chrome-extension

npm i https://pkg.pr.new/@clerk/chrome-extension@9867

@clerk/clerk-js

npm i https://pkg.pr.new/@clerk/clerk-js@9867

@clerk/electron

npm i https://pkg.pr.new/@clerk/electron@9867

@clerk/electron-passkeys

npm i https://pkg.pr.new/@clerk/electron-passkeys@9867

@clerk/eslint-plugin

npm i https://pkg.pr.new/@clerk/eslint-plugin@9867

@clerk/expo

npm i https://pkg.pr.new/@clerk/expo@9867

@clerk/expo-google-signin

npm i https://pkg.pr.new/@clerk/expo-google-signin@9867

@clerk/expo-passkeys

npm i https://pkg.pr.new/@clerk/expo-passkeys@9867

@clerk/express

npm i https://pkg.pr.new/@clerk/express@9867

@clerk/fastify

npm i https://pkg.pr.new/@clerk/fastify@9867

@clerk/hono

npm i https://pkg.pr.new/@clerk/hono@9867

@clerk/localizations

npm i https://pkg.pr.new/@clerk/localizations@9867

@clerk/mosaic

npm i https://pkg.pr.new/@clerk/mosaic@9867

@clerk/nextjs

npm i https://pkg.pr.new/@clerk/nextjs@9867

@clerk/nuxt

npm i https://pkg.pr.new/@clerk/nuxt@9867

@clerk/react

npm i https://pkg.pr.new/@clerk/react@9867

@clerk/react-router

npm i https://pkg.pr.new/@clerk/react-router@9867

@clerk/shared

npm i https://pkg.pr.new/@clerk/shared@9867

@clerk/tanstack-react-start

npm i https://pkg.pr.new/@clerk/tanstack-react-start@9867

@clerk/testing

npm i https://pkg.pr.new/@clerk/testing@9867

@clerk/ui

npm i https://pkg.pr.new/@clerk/ui@9867

@clerk/upgrade

npm i https://pkg.pr.new/@clerk/upgrade@9867

@clerk/vue

npm i https://pkg.pr.new/@clerk/vue@9867

commit: 327380d

[github-actions]

API Changes Report

Generated by Break Check on 2026-09-22T19:44:40.295Z

Summary

Metric	Count
Packages analyzed	19
Packages with changes	1
🔴 Breaking changes	0
🟡 Non-breaking changes	1
🟢 Additions	0

🤖 This report was reviewed by claude-sonnet-4-6.

---

@clerk/ui

Current version: 1.33.1
Recommended bump: MINOR → 1.34.0

Subpath ./themes/experimental

🟡 Non-breaking Changes (1)

Modified: createTheme

// ... 4 unchanged lines elided ...
      theme: InternalTheme;
    }) => Elements);
    theme?: (BaseTheme | BaseTheme[]) | undefined;
-   options?: import("@clerk/ui/internal").Options | undefined;
-   variables?: import("@clerk/ui/internal").Variables | undefined;
-   captcha?: import("@clerk/ui/internal").CaptchaAppearanceOptions | undefined;
+   options?: Options | undefined;
+   variables?: Variables | undefined;
+   captcha?: CaptchaAppearanceOptions | undefined;
    cssLayerName?: string | undefined;
  }

Static analyzer: Breaking change in function createTheme: Return type changed: {__type:"prebuilt_appearance";name?:string;elements?:!unknown|((params:{theme:import("@clerk/ui").~InternalTheme;})=>!unknown);theme?:(!unknown|!unknown[])|undefined;options?:import("@clerk/ui/internal").Options|undefined;variables?:import("@clerk/ui/internal").Variables|undefined;captcha?:import("@clerk/ui/internal").CaptchaAppearanceOptions|undefined;cssLayerName?:string|undefined;} → {__type:"prebuilt_appearance";name?:string;elements?:((params:{theme:import("@clerk/ui").~InternalTheme;})=>import("@clerk/ui").~Elements)|import("@clerk/ui").~Elements;theme?:(import("@clerk/ui").~BaseTheme|import("@clerk/ui").~BaseTheme[])|undefined;options?:import("@clerk/ui").~Options|undefined;variables?:import("@clerk/ui").~Variables|undefined;captcha?:import("@clerk/ui").~CaptchaAppearanceOptions|undefined;cssLayerName?:string|undefined;}

🤖 AI review (reclassified as non-breaking) (85%): The before and after snippets show structurally identical return types; the only change is that Options, Variables, and CaptchaAppearanceOptions are now imported from @clerk/ui (a public entry point) instead of @clerk/ui/internal (whose resolvability is unknown/unverified). Per rule 13, swapping a potentially non-resolvable specifier for a verified public one is a repair, not a break, and the structural shape is identical.

---

Report generated by Break Check

_{Last ran on 327380d.}