docs(repo): add headless primitives reference to mosaic skill - #9239

Merged
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference
Jul 24, 2026
Merged

docs(repo): add headless primitives reference to mosaic skill#9239
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference

Conversation

@alexcarpenter

Copy link
Copy Markdown
Member

Description

Adds a reference doc for working with the @clerk/headless package components, within the mosaic skill, and fixes stale docs.

What's here

  • New references/headless.md in the mosaic skill — a how-to for the shared headless conventions (the per-primitive API docs stay in each src/primitives/<name>/README.md, which this points to):
    • Consuming a primitive (namespace compound components, render function-or-element override, data-* styling, makeCustomizable from @clerk/ui).
    • Authoring a part: the useRender contract + param table, universal rules ('use client', forwardRef, ownProps satisfies DefaultProps<Tag>, mergeProps(internal, consumer) ordering), stateAttributesMapping.
    • Primitive file layout, Portal root+mounted convention, the data-* animation lifecycle, shared hooks (useControllableState, useTransition, …) and utils (cssVars, resetLayoutStyles).
  • Routing row added to the mosaic SKILL.md table.
  • Fixes stale renderElement references in packages/headless/README.md (renderElement was removed in feat(headless): remove renderElement, consolidate into useRender #9233 and consolidated into useRender; the dist-path in the TS2742 note is now use-render).

Changeset

Empty — docs/tooling only, and the README change is in the private @clerk/headless package. No user-facing published change.

Adds a how-to reference for @clerk/headless (consuming primitives, the useRender part-authoring contract, file layout, animation lifecycle, shared hooks/utils) and routes to it from the mosaic skill. Fixes stale renderElement references in the headless README (removed in favor of useRender).
@changeset-bot

changeset-botBot commented Jul 24, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a7512c0

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@vercel

vercelBot commented Jul 24, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 24, 2026 4:04pm
swingsetReadyReadyPreview, CommentJul 24, 2026 4:04pm

Request Review

@pkg-pr-new

pkg-pr-newBot commented Jul 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: a7512c0

@coderabbitai

coderabbitaiBot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 71fa2f8e-cf14-4577-b2e5-4d732153a864

📥 Commits

Reviewing files that changed from the base of the PR and between 478d3dd and a7512c0.

📒 Files selected for processing (2)
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .claude/skills/mosaic/references/headless.md

📝 Walkthrough

Walkthrough

Adds Mosaic documentation for @clerk/headless, covering primitive composition, useRender, state attributes, component structure, portals, animations, shared APIs, and testing. Links the reference from the Mosaic skill guide, adds a changeset, and updates the package README from renderElement to useRender.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly summarizes the main change: adding a headless primitives reference to the Mosaic skill.
Description check✅ PassedThe description is directly related to the changeset and accurately describes the new docs and stale reference updates.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/mosaic/references/headless.md:
- Around line 52-62: Align the documentation’s useRender contract across both
sites: in .claude/skills/mosaic/references/headless.md, scope native props and
render behavior to each element-rendering part and state that pass-through parts
such as Root and Portal have their own APIs; in packages/headless/README.md,
change the useRender description to say that every part rendering a DOM element
calls the hook.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 29d85d06-ed0a-4ad5-9894-bafa2fa0a1b3

📥 Commits

Reviewing files that changed from the base of the PR and between 1f8d89f and 478d3dd.

📒 Files selected for processing (4)
  • .changeset/mosaic-headless-reference-doc.md
  • .claude/skills/mosaic/SKILL.md
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)

Comment thread.claude/skills/mosaic/references/headless.md Outdated
@alexcarpenter
alexcarpenter enabled auto-merge (squash) July 24, 2026 16:01
@alexcarpenter
alexcarpenter merged commit 2466247 into mainJul 24, 2026
49 checks passed
@alexcarpenter
alexcarpenter deleted the carp/mosaic-headless-reference branch July 24, 2026 16:07
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@alexcarpenter@kylemac
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

docs(repo): add headless primitives reference to mosaic skill - #9239

Merged
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference
Jul 24, 2026
Merged

docs(repo): add headless primitives reference to mosaic skill#9239
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference

Conversation

@alexcarpenter

Copy link
Copy Markdown
Member

Description

Adds a reference doc for working with the @clerk/headless package components, within the mosaic skill, and fixes stale docs.

What's here

  • New references/headless.md in the mosaic skill — a how-to for the shared headless conventions (the per-primitive API docs stay in each src/primitives/<name>/README.md, which this points to):
    • Consuming a primitive (namespace compound components, render function-or-element override, data-* styling, makeCustomizable from @clerk/ui).
    • Authoring a part: the useRender contract + param table, universal rules ('use client', forwardRef, ownProps satisfies DefaultProps<Tag>, mergeProps(internal, consumer) ordering), stateAttributesMapping.
    • Primitive file layout, Portal root+mounted convention, the data-* animation lifecycle, shared hooks (useControllableState, useTransition, …) and utils (cssVars, resetLayoutStyles).
  • Routing row added to the mosaic SKILL.md table.
  • Fixes stale renderElement references in packages/headless/README.md (renderElement was removed in feat(headless): remove renderElement, consolidate into useRender #9233 and consolidated into useRender; the dist-path in the TS2742 note is now use-render).

Changeset

Empty — docs/tooling only, and the README change is in the private @clerk/headless package. No user-facing published change.

Adds a how-to reference for @clerk/headless (consuming primitives, the useRender part-authoring contract, file layout, animation lifecycle, shared hooks/utils) and routes to it from the mosaic skill. Fixes stale renderElement references in the headless README (removed in favor of useRender).
@changeset-bot

changeset-botBot commented Jul 24, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a7512c0

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@vercel

vercelBot commented Jul 24, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 24, 2026 4:04pm
swingsetReadyReadyPreview, CommentJul 24, 2026 4:04pm

Request Review

@pkg-pr-new

pkg-pr-newBot commented Jul 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: a7512c0

@coderabbitai

coderabbitaiBot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 71fa2f8e-cf14-4577-b2e5-4d732153a864

📥 Commits

Reviewing files that changed from the base of the PR and between 478d3dd and a7512c0.

📒 Files selected for processing (2)
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .claude/skills/mosaic/references/headless.md

📝 Walkthrough

Walkthrough

Adds Mosaic documentation for @clerk/headless, covering primitive composition, useRender, state attributes, component structure, portals, animations, shared APIs, and testing. Links the reference from the Mosaic skill guide, adds a changeset, and updates the package README from renderElement to useRender.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly summarizes the main change: adding a headless primitives reference to the Mosaic skill.
Description check✅ PassedThe description is directly related to the changeset and accurately describes the new docs and stale reference updates.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/mosaic/references/headless.md:
- Around line 52-62: Align the documentation’s useRender contract across both
sites: in .claude/skills/mosaic/references/headless.md, scope native props and
render behavior to each element-rendering part and state that pass-through parts
such as Root and Portal have their own APIs; in packages/headless/README.md,
change the useRender description to say that every part rendering a DOM element
calls the hook.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 29d85d06-ed0a-4ad5-9894-bafa2fa0a1b3

📥 Commits

Reviewing files that changed from the base of the PR and between 1f8d89f and 478d3dd.

📒 Files selected for processing (4)
  • .changeset/mosaic-headless-reference-doc.md
  • .claude/skills/mosaic/SKILL.md
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)

Comment thread.claude/skills/mosaic/references/headless.md Outdated
@alexcarpenter
alexcarpenter enabled auto-merge (squash) July 24, 2026 16:01
@alexcarpenter
alexcarpenter merged commit 2466247 into mainJul 24, 2026
49 checks passed
@alexcarpenter
alexcarpenter deleted the carp/mosaic-headless-reference branch July 24, 2026 16:07
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@alexcarpenter@kylemac
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(repo): add headless primitives reference to mosaic skill - #9239

Merged
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference
Jul 24, 2026
Merged

docs(repo): add headless primitives reference to mosaic skill#9239
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference

Conversation

@alexcarpenter

Copy link
Copy Markdown
Member

Description

Adds a reference doc for working with the @clerk/headless package components, within the mosaic skill, and fixes stale docs.

What's here

  • New references/headless.md in the mosaic skill — a how-to for the shared headless conventions (the per-primitive API docs stay in each src/primitives/<name>/README.md, which this points to):
    • Consuming a primitive (namespace compound components, render function-or-element override, data-* styling, makeCustomizable from @clerk/ui).
    • Authoring a part: the useRender contract + param table, universal rules ('use client', forwardRef, ownProps satisfies DefaultProps<Tag>, mergeProps(internal, consumer) ordering), stateAttributesMapping.
    • Primitive file layout, Portal root+mounted convention, the data-* animation lifecycle, shared hooks (useControllableState, useTransition, …) and utils (cssVars, resetLayoutStyles).
  • Routing row added to the mosaic SKILL.md table.
  • Fixes stale renderElement references in packages/headless/README.md (renderElement was removed in feat(headless): remove renderElement, consolidate into useRender #9233 and consolidated into useRender; the dist-path in the TS2742 note is now use-render).

Changeset

Empty — docs/tooling only, and the README change is in the private @clerk/headless package. No user-facing published change.

Adds a how-to reference for @clerk/headless (consuming primitives, the useRender part-authoring contract, file layout, animation lifecycle, shared hooks/utils) and routes to it from the mosaic skill. Fixes stale renderElement references in the headless README (removed in favor of useRender).
@changeset-bot

changeset-botBot commented Jul 24, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a7512c0

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@vercel

vercelBot commented Jul 24, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 24, 2026 4:04pm
swingsetReadyReadyPreview, CommentJul 24, 2026 4:04pm

Request Review

@pkg-pr-new

pkg-pr-newBot commented Jul 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: a7512c0

@coderabbitai

coderabbitaiBot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 71fa2f8e-cf14-4577-b2e5-4d732153a864

📥 Commits

Reviewing files that changed from the base of the PR and between 478d3dd and a7512c0.

📒 Files selected for processing (2)
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .claude/skills/mosaic/references/headless.md

📝 Walkthrough

Walkthrough

Adds Mosaic documentation for @clerk/headless, covering primitive composition, useRender, state attributes, component structure, portals, animations, shared APIs, and testing. Links the reference from the Mosaic skill guide, adds a changeset, and updates the package README from renderElement to useRender.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly summarizes the main change: adding a headless primitives reference to the Mosaic skill.
Description check✅ PassedThe description is directly related to the changeset and accurately describes the new docs and stale reference updates.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/mosaic/references/headless.md:
- Around line 52-62: Align the documentation’s useRender contract across both
sites: in .claude/skills/mosaic/references/headless.md, scope native props and
render behavior to each element-rendering part and state that pass-through parts
such as Root and Portal have their own APIs; in packages/headless/README.md,
change the useRender description to say that every part rendering a DOM element
calls the hook.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 29d85d06-ed0a-4ad5-9894-bafa2fa0a1b3

📥 Commits

Reviewing files that changed from the base of the PR and between 1f8d89f and 478d3dd.

📒 Files selected for processing (4)
  • .changeset/mosaic-headless-reference-doc.md
  • .claude/skills/mosaic/SKILL.md
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)

Comment thread.claude/skills/mosaic/references/headless.md Outdated
@alexcarpenter
alexcarpenter enabled auto-merge (squash) July 24, 2026 16:01
@alexcarpenter
alexcarpenter merged commit 2466247 into mainJul 24, 2026
49 checks passed
@alexcarpenter
alexcarpenter deleted the carp/mosaic-headless-reference branch July 24, 2026 16:07
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@alexcarpenter@kylemac
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(repo): add headless primitives reference to mosaic skill - #9239

Merged
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference
Jul 24, 2026
Merged

docs(repo): add headless primitives reference to mosaic skill#9239
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference

Conversation

@alexcarpenter

Copy link
Copy Markdown
Member

Description

Adds a reference doc for working with the @clerk/headless package components, within the mosaic skill, and fixes stale docs.

What's here

  • New references/headless.md in the mosaic skill — a how-to for the shared headless conventions (the per-primitive API docs stay in each src/primitives/<name>/README.md, which this points to):
    • Consuming a primitive (namespace compound components, render function-or-element override, data-* styling, makeCustomizable from @clerk/ui).
    • Authoring a part: the useRender contract + param table, universal rules ('use client', forwardRef, ownProps satisfies DefaultProps<Tag>, mergeProps(internal, consumer) ordering), stateAttributesMapping.
    • Primitive file layout, Portal root+mounted convention, the data-* animation lifecycle, shared hooks (useControllableState, useTransition, …) and utils (cssVars, resetLayoutStyles).
  • Routing row added to the mosaic SKILL.md table.
  • Fixes stale renderElement references in packages/headless/README.md (renderElement was removed in feat(headless): remove renderElement, consolidate into useRender #9233 and consolidated into useRender; the dist-path in the TS2742 note is now use-render).

Changeset

Empty — docs/tooling only, and the README change is in the private @clerk/headless package. No user-facing published change.

Adds a how-to reference for @clerk/headless (consuming primitives, the useRender part-authoring contract, file layout, animation lifecycle, shared hooks/utils) and routes to it from the mosaic skill. Fixes stale renderElement references in the headless README (removed in favor of useRender).
@changeset-bot

changeset-botBot commented Jul 24, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a7512c0

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@vercel

vercelBot commented Jul 24, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 24, 2026 4:04pm
swingsetReadyReadyPreview, CommentJul 24, 2026 4:04pm

Request Review

@pkg-pr-new

pkg-pr-newBot commented Jul 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: a7512c0

@coderabbitai

coderabbitaiBot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 71fa2f8e-cf14-4577-b2e5-4d732153a864

📥 Commits

Reviewing files that changed from the base of the PR and between 478d3dd and a7512c0.

📒 Files selected for processing (2)
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .claude/skills/mosaic/references/headless.md

📝 Walkthrough

Walkthrough

Adds Mosaic documentation for @clerk/headless, covering primitive composition, useRender, state attributes, component structure, portals, animations, shared APIs, and testing. Links the reference from the Mosaic skill guide, adds a changeset, and updates the package README from renderElement to useRender.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly summarizes the main change: adding a headless primitives reference to the Mosaic skill.
Description check✅ PassedThe description is directly related to the changeset and accurately describes the new docs and stale reference updates.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/mosaic/references/headless.md:
- Around line 52-62: Align the documentation’s useRender contract across both
sites: in .claude/skills/mosaic/references/headless.md, scope native props and
render behavior to each element-rendering part and state that pass-through parts
such as Root and Portal have their own APIs; in packages/headless/README.md,
change the useRender description to say that every part rendering a DOM element
calls the hook.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 29d85d06-ed0a-4ad5-9894-bafa2fa0a1b3

📥 Commits

Reviewing files that changed from the base of the PR and between 1f8d89f and 478d3dd.

📒 Files selected for processing (4)
  • .changeset/mosaic-headless-reference-doc.md
  • .claude/skills/mosaic/SKILL.md
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)

Comment thread.claude/skills/mosaic/references/headless.md Outdated
@alexcarpenter
alexcarpenter enabled auto-merge (squash) July 24, 2026 16:01
@alexcarpenter
alexcarpenter merged commit 2466247 into mainJul 24, 2026
49 checks passed
@alexcarpenter
alexcarpenter deleted the carp/mosaic-headless-reference branch July 24, 2026 16:07
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@alexcarpenter@kylemac
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

docs(repo): add headless primitives reference to mosaic skill - #9239

Merged
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference
Jul 24, 2026
Merged

docs(repo): add headless primitives reference to mosaic skill#9239
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference

Conversation

@alexcarpenter

Copy link
Copy Markdown
Member

Description

Adds a reference doc for working with the @clerk/headless package components, within the mosaic skill, and fixes stale docs.

What's here

  • New references/headless.md in the mosaic skill — a how-to for the shared headless conventions (the per-primitive API docs stay in each src/primitives/<name>/README.md, which this points to):
    • Consuming a primitive (namespace compound components, render function-or-element override, data-* styling, makeCustomizable from @clerk/ui).
    • Authoring a part: the useRender contract + param table, universal rules ('use client', forwardRef, ownProps satisfies DefaultProps<Tag>, mergeProps(internal, consumer) ordering), stateAttributesMapping.
    • Primitive file layout, Portal root+mounted convention, the data-* animation lifecycle, shared hooks (useControllableState, useTransition, …) and utils (cssVars, resetLayoutStyles).
  • Routing row added to the mosaic SKILL.md table.
  • Fixes stale renderElement references in packages/headless/README.md (renderElement was removed in feat(headless): remove renderElement, consolidate into useRender #9233 and consolidated into useRender; the dist-path in the TS2742 note is now use-render).

Changeset

Empty — docs/tooling only, and the README change is in the private @clerk/headless package. No user-facing published change.

Adds a how-to reference for @clerk/headless (consuming primitives, the useRender part-authoring contract, file layout, animation lifecycle, shared hooks/utils) and routes to it from the mosaic skill. Fixes stale renderElement references in the headless README (removed in favor of useRender).
@changeset-bot

changeset-botBot commented Jul 24, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a7512c0

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@vercel

vercelBot commented Jul 24, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 24, 2026 4:04pm
swingsetReadyReadyPreview, CommentJul 24, 2026 4:04pm

Request Review

@pkg-pr-new

pkg-pr-newBot commented Jul 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: a7512c0

@coderabbitai

coderabbitaiBot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 71fa2f8e-cf14-4577-b2e5-4d732153a864

📥 Commits

Reviewing files that changed from the base of the PR and between 478d3dd and a7512c0.

📒 Files selected for processing (2)
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .claude/skills/mosaic/references/headless.md

📝 Walkthrough

Walkthrough

Adds Mosaic documentation for @clerk/headless, covering primitive composition, useRender, state attributes, component structure, portals, animations, shared APIs, and testing. Links the reference from the Mosaic skill guide, adds a changeset, and updates the package README from renderElement to useRender.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly summarizes the main change: adding a headless primitives reference to the Mosaic skill.
Description check✅ PassedThe description is directly related to the changeset and accurately describes the new docs and stale reference updates.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/mosaic/references/headless.md:
- Around line 52-62: Align the documentation’s useRender contract across both
sites: in .claude/skills/mosaic/references/headless.md, scope native props and
render behavior to each element-rendering part and state that pass-through parts
such as Root and Portal have their own APIs; in packages/headless/README.md,
change the useRender description to say that every part rendering a DOM element
calls the hook.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 29d85d06-ed0a-4ad5-9894-bafa2fa0a1b3

📥 Commits

Reviewing files that changed from the base of the PR and between 1f8d89f and 478d3dd.

📒 Files selected for processing (4)
  • .changeset/mosaic-headless-reference-doc.md
  • .claude/skills/mosaic/SKILL.md
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)

Comment thread.claude/skills/mosaic/references/headless.md Outdated
@alexcarpenter
alexcarpenter enabled auto-merge (squash) July 24, 2026 16:01
@alexcarpenter
alexcarpenter merged commit 2466247 into mainJul 24, 2026
49 checks passed
@alexcarpenter
alexcarpenter deleted the carp/mosaic-headless-reference branch July 24, 2026 16:07
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@alexcarpenter@kylemac
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(repo): add headless primitives reference to mosaic skill - #9239

Merged
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference
Jul 24, 2026
Merged

docs(repo): add headless primitives reference to mosaic skill#9239
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference

Conversation

@alexcarpenter

Copy link
Copy Markdown
Member

Description

Adds a reference doc for working with the @clerk/headless package components, within the mosaic skill, and fixes stale docs.

What's here

  • New references/headless.md in the mosaic skill — a how-to for the shared headless conventions (the per-primitive API docs stay in each src/primitives/<name>/README.md, which this points to):
    • Consuming a primitive (namespace compound components, render function-or-element override, data-* styling, makeCustomizable from @clerk/ui).
    • Authoring a part: the useRender contract + param table, universal rules ('use client', forwardRef, ownProps satisfies DefaultProps<Tag>, mergeProps(internal, consumer) ordering), stateAttributesMapping.
    • Primitive file layout, Portal root+mounted convention, the data-* animation lifecycle, shared hooks (useControllableState, useTransition, …) and utils (cssVars, resetLayoutStyles).
  • Routing row added to the mosaic SKILL.md table.
  • Fixes stale renderElement references in packages/headless/README.md (renderElement was removed in feat(headless): remove renderElement, consolidate into useRender #9233 and consolidated into useRender; the dist-path in the TS2742 note is now use-render).

Changeset

Empty — docs/tooling only, and the README change is in the private @clerk/headless package. No user-facing published change.

Adds a how-to reference for @clerk/headless (consuming primitives, the useRender part-authoring contract, file layout, animation lifecycle, shared hooks/utils) and routes to it from the mosaic skill. Fixes stale renderElement references in the headless README (removed in favor of useRender).
@changeset-bot

changeset-botBot commented Jul 24, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a7512c0

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@vercel

vercelBot commented Jul 24, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 24, 2026 4:04pm
swingsetReadyReadyPreview, CommentJul 24, 2026 4:04pm

Request Review

@pkg-pr-new

pkg-pr-newBot commented Jul 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: a7512c0

@coderabbitai

coderabbitaiBot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 71fa2f8e-cf14-4577-b2e5-4d732153a864

📥 Commits

Reviewing files that changed from the base of the PR and between 478d3dd and a7512c0.

📒 Files selected for processing (2)
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .claude/skills/mosaic/references/headless.md

📝 Walkthrough

Walkthrough

Adds Mosaic documentation for @clerk/headless, covering primitive composition, useRender, state attributes, component structure, portals, animations, shared APIs, and testing. Links the reference from the Mosaic skill guide, adds a changeset, and updates the package README from renderElement to useRender.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly summarizes the main change: adding a headless primitives reference to the Mosaic skill.
Description check✅ PassedThe description is directly related to the changeset and accurately describes the new docs and stale reference updates.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/mosaic/references/headless.md:
- Around line 52-62: Align the documentation’s useRender contract across both
sites: in .claude/skills/mosaic/references/headless.md, scope native props and
render behavior to each element-rendering part and state that pass-through parts
such as Root and Portal have their own APIs; in packages/headless/README.md,
change the useRender description to say that every part rendering a DOM element
calls the hook.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 29d85d06-ed0a-4ad5-9894-bafa2fa0a1b3

📥 Commits

Reviewing files that changed from the base of the PR and between 1f8d89f and 478d3dd.

📒 Files selected for processing (4)
  • .changeset/mosaic-headless-reference-doc.md
  • .claude/skills/mosaic/SKILL.md
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)

Comment thread.claude/skills/mosaic/references/headless.md Outdated
@alexcarpenter
alexcarpenter enabled auto-merge (squash) July 24, 2026 16:01
@alexcarpenter
alexcarpenter merged commit 2466247 into mainJul 24, 2026
49 checks passed
@alexcarpenter
alexcarpenter deleted the carp/mosaic-headless-reference branch July 24, 2026 16:07
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@alexcarpenter@kylemac
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

docs(repo): add headless primitives reference to mosaic skill - #9239

Merged
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference
Jul 24, 2026
Merged

docs(repo): add headless primitives reference to mosaic skill#9239
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference

Conversation

@alexcarpenter

Copy link
Copy Markdown
Member

Description

Adds a reference doc for working with the @clerk/headless package components, within the mosaic skill, and fixes stale docs.

What's here

  • New references/headless.md in the mosaic skill — a how-to for the shared headless conventions (the per-primitive API docs stay in each src/primitives/<name>/README.md, which this points to):
    • Consuming a primitive (namespace compound components, render function-or-element override, data-* styling, makeCustomizable from @clerk/ui).
    • Authoring a part: the useRender contract + param table, universal rules ('use client', forwardRef, ownProps satisfies DefaultProps<Tag>, mergeProps(internal, consumer) ordering), stateAttributesMapping.
    • Primitive file layout, Portal root+mounted convention, the data-* animation lifecycle, shared hooks (useControllableState, useTransition, …) and utils (cssVars, resetLayoutStyles).
  • Routing row added to the mosaic SKILL.md table.
  • Fixes stale renderElement references in packages/headless/README.md (renderElement was removed in feat(headless): remove renderElement, consolidate into useRender #9233 and consolidated into useRender; the dist-path in the TS2742 note is now use-render).

Changeset

Empty — docs/tooling only, and the README change is in the private @clerk/headless package. No user-facing published change.

Adds a how-to reference for @clerk/headless (consuming primitives, the useRender part-authoring contract, file layout, animation lifecycle, shared hooks/utils) and routes to it from the mosaic skill. Fixes stale renderElement references in the headless README (removed in favor of useRender).
@changeset-bot

changeset-botBot commented Jul 24, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a7512c0

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@vercel

vercelBot commented Jul 24, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 24, 2026 4:04pm
swingsetReadyReadyPreview, CommentJul 24, 2026 4:04pm

Request Review

@pkg-pr-new

pkg-pr-newBot commented Jul 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: a7512c0

@coderabbitai

coderabbitaiBot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 71fa2f8e-cf14-4577-b2e5-4d732153a864

📥 Commits

Reviewing files that changed from the base of the PR and between 478d3dd and a7512c0.

📒 Files selected for processing (2)
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .claude/skills/mosaic/references/headless.md

📝 Walkthrough

Walkthrough

Adds Mosaic documentation for @clerk/headless, covering primitive composition, useRender, state attributes, component structure, portals, animations, shared APIs, and testing. Links the reference from the Mosaic skill guide, adds a changeset, and updates the package README from renderElement to useRender.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly summarizes the main change: adding a headless primitives reference to the Mosaic skill.
Description check✅ PassedThe description is directly related to the changeset and accurately describes the new docs and stale reference updates.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/mosaic/references/headless.md:
- Around line 52-62: Align the documentation’s useRender contract across both
sites: in .claude/skills/mosaic/references/headless.md, scope native props and
render behavior to each element-rendering part and state that pass-through parts
such as Root and Portal have their own APIs; in packages/headless/README.md,
change the useRender description to say that every part rendering a DOM element
calls the hook.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 29d85d06-ed0a-4ad5-9894-bafa2fa0a1b3

📥 Commits

Reviewing files that changed from the base of the PR and between 1f8d89f and 478d3dd.

📒 Files selected for processing (4)
  • .changeset/mosaic-headless-reference-doc.md
  • .claude/skills/mosaic/SKILL.md
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)

Comment thread.claude/skills/mosaic/references/headless.md Outdated
@alexcarpenter
alexcarpenter enabled auto-merge (squash) July 24, 2026 16:01
@alexcarpenter
alexcarpenter merged commit 2466247 into mainJul 24, 2026
49 checks passed
@alexcarpenter
alexcarpenter deleted the carp/mosaic-headless-reference branch July 24, 2026 16:07
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@alexcarpenter@kylemac
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

docs(repo): add headless primitives reference to mosaic skill - #9239

Merged
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference
Jul 24, 2026
Merged

docs(repo): add headless primitives reference to mosaic skill#9239
alexcarpenter merged 4 commits into
mainfrom
carp/mosaic-headless-reference

Conversation

@alexcarpenter

Copy link
Copy Markdown
Member

Description

Adds a reference doc for working with the @clerk/headless package components, within the mosaic skill, and fixes stale docs.

What's here

  • New references/headless.md in the mosaic skill — a how-to for the shared headless conventions (the per-primitive API docs stay in each src/primitives/<name>/README.md, which this points to):
    • Consuming a primitive (namespace compound components, render function-or-element override, data-* styling, makeCustomizable from @clerk/ui).
    • Authoring a part: the useRender contract + param table, universal rules ('use client', forwardRef, ownProps satisfies DefaultProps<Tag>, mergeProps(internal, consumer) ordering), stateAttributesMapping.
    • Primitive file layout, Portal root+mounted convention, the data-* animation lifecycle, shared hooks (useControllableState, useTransition, …) and utils (cssVars, resetLayoutStyles).
  • Routing row added to the mosaic SKILL.md table.
  • Fixes stale renderElement references in packages/headless/README.md (renderElement was removed in feat(headless): remove renderElement, consolidate into useRender #9233 and consolidated into useRender; the dist-path in the TS2742 note is now use-render).

Changeset

Empty — docs/tooling only, and the README change is in the private @clerk/headless package. No user-facing published change.

Adds a how-to reference for @clerk/headless (consuming primitives, the useRender part-authoring contract, file layout, animation lifecycle, shared hooks/utils) and routes to it from the mosaic skill. Fixes stale renderElement references in the headless README (removed in favor of useRender).
@changeset-bot

changeset-botBot commented Jul 24, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a7512c0

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

This PR includes changesets to release 0 packages

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

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

@vercel

vercelBot commented Jul 24, 2026

Copy link
Copy Markdown

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

ProjectDeploymentActionsUpdated (UTC)
clerk-js-sandboxReadyReadyPreview, CommentJul 24, 2026 4:04pm
swingsetReadyReadyPreview, CommentJul 24, 2026 4:04pm

Request Review

@pkg-pr-new

pkg-pr-newBot commented Jul 24, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: a7512c0

@coderabbitai

coderabbitaiBot commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 71fa2f8e-cf14-4577-b2e5-4d732153a864

📥 Commits

Reviewing files that changed from the base of the PR and between 478d3dd and a7512c0.

📒 Files selected for processing (2)
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)
🚧 Files skipped from review as they are similar to previous changes (1)
  • .claude/skills/mosaic/references/headless.md

📝 Walkthrough

Walkthrough

Adds Mosaic documentation for @clerk/headless, covering primitive composition, useRender, state attributes, component structure, portals, animations, shared APIs, and testing. Links the reference from the Mosaic skill guide, adds a changeset, and updates the package README from renderElement to useRender.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Title check✅ PassedThe title clearly summarizes the main change: adding a headless primitives reference to the Mosaic skill.
Description check✅ PassedThe description is directly related to the changeset and accurately describes the new docs and stale reference updates.
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check✅ PassedCheck skipped because no linked issues were found for this pull request.
Out of Scope Changes check✅ PassedCheck skipped because no linked issues were found for this pull request.

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

@coderabbitaicoderabbitaiBot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In @.claude/skills/mosaic/references/headless.md:
- Around line 52-62: Align the documentation’s useRender contract across both
sites: in .claude/skills/mosaic/references/headless.md, scope native props and
render behavior to each element-rendering part and state that pass-through parts
such as Root and Portal have their own APIs; in packages/headless/README.md,
change the useRender description to say that every part rendering a DOM element
calls the hook.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

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

Review profile: CHILL

Plan: Pro Plus

Run ID: 29d85d06-ed0a-4ad5-9894-bafa2fa0a1b3

📥 Commits

Reviewing files that changed from the base of the PR and between 1f8d89f and 478d3dd.

📒 Files selected for processing (4)
  • .changeset/mosaic-headless-reference-doc.md
  • .claude/skills/mosaic/SKILL.md
  • .claude/skills/mosaic/references/headless.md
  • packages/headless/README.md
🔗 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)
  • clerk/clerk-docs(manual)
  • clerk/cloudflare-workers(manual)
  • clerk/cli(auto-detected)
  • clerk/clerk-ios(auto-detected)
  • clerk/clerk-android(auto-detected)

Comment thread.claude/skills/mosaic/references/headless.md Outdated
@alexcarpenter
alexcarpenter enabled auto-merge (squash) July 24, 2026 16:01
@alexcarpenter
alexcarpenter merged commit 2466247 into mainJul 24, 2026
49 checks passed
@alexcarpenter
alexcarpenter deleted the carp/mosaic-headless-reference branch July 24, 2026 16:07
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@alexcarpenter@kylemac