Skip to content

feat(headless): migrate remaining primitives to useRender#9232

Merged
alexcarpenter merged 3 commits into
mainfrom
carp/mosaic-use-render-pr2
Jul 23, 2026
Merged

feat(headless): migrate remaining primitives to useRender#9232
alexcarpenter merged 3 commits into
mainfrom
carp/mosaic-use-render-pr2

Conversation

@alexcarpenter

Copy link
Copy Markdown
Member

Stacked on #9231. Merge that first.

PR2 of the renderElementuseRender migration. #9231 added the useRender hook and converted Mosaic + a couple representative primitives. This converts every remaining primitive family so renderElement has no callers left (final PR deletes it).

What changed

58 primitives across accordion, autocomplete, collapsible, dialog, drawer, file-upload, menu, otp, popover, select, tabs, tooltip. Mechanical swap, three transforms:

Refs merge inside the hook. Per-site useMergeRefs disappears.

// before
const combinedRef = useMergeRefs([popupRef, refs.setFloating, ref]);
const defaultProps = { ref: combinedRef, ...getFloatingProps() };
return renderElement({ defaultTagName: 'div', render, props: mergeProps(defaultProps, otherProps) });

// after
return useRender({ defaultTagName: 'div', render, ref: [popupRef, refs.setFloating, ref], props: mergeProps(defaultProps, otherProps) });

mounted guard becomes enabled. Hook stays unconditional (returns null).

// before
if (!mounted) return null;
return renderElement({ ... });

// after (wrapped-in-JSX case)
const element = useRender({ ..., enabled: mounted });
if (!element) return null;
return <FloatingFocusManager ...>{element}</FloatingFocusManager>;

Composite/CompositeItem callbacks. floating-ui invokes the render callback synchronously during its own render (see renderJsx), so useRender there is runtime-safe but trips react-hooks/rules-of-hooks — carries a justified disable. The callback's injected roving-tabindex ref is extracted to the ref param (leaving it in props would let the hook's merged ref clobber it and break keyboard nav).

Ref safety

useRender overwrites any ref left in props with its own merged ref. So every ref was routed to the ref param, nothing left in props. Roving-focus/ref-forwarding tests cover the Composite cases.

Verified

  • @clerk/headless: 601 tests pass, typecheck clean, eslint clean (zero warnings)
  • no renderElement callers remain in src/primitives

Empty changeset: @clerk/headless is private.

Introduces a base-ui-style useRender hook: a render prop that accepts a
React element (render={<Link/>}) or a function, with internal ref merging
and state-to-data-attribute mapping. renderElement stays exported for the
phased migration. Migrates Mosaic Box, Heading, Text and the dialog
trigger/popup primitives onto the hook.
Convert the rest of the primitive families (accordion, autocomplete, collapsible, dialog, drawer, file-upload, menu, otp, popover, select, tabs, tooltip) from the renderElement function to the useRender hook.

Refs move to useRender's ref param; mounted guards become the enabled param; Composite/CompositeItem render callbacks extract the injected roving-tabindex ref and carry a rules-of-hooks disable justified by floating-ui invoking the callback synchronously during render.

renderElement remains exported for the final cleanup PR.
@changeset-bot

changeset-bot Bot commented Jul 23, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: a24606c

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

vercel Bot commented Jul 23, 2026

Copy link
Copy Markdown

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

Project Deployment Actions Updated (UTC)
clerk-js-sandbox Ready Ready Preview, Comment Jul 23, 2026 10:30pm
swingset Ready Ready Preview, Comment Jul 23, 2026 10:30pm

Request Review

@pkg-pr-new

pkg-pr-new Bot commented Jul 23, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: a24606c

@coderabbitai

coderabbitai Bot commented Jul 23, 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: 5b6557dd-238d-4c41-81c2-201740932479

📥 Commits

Reviewing files that changed from the base of the PR and between 17d1db1 and a24606c.

📒 Files selected for processing (60)
  • .changeset/headless-primitives-use-render.md
  • packages/headless/src/primitives/accordion/accordion-header.tsx
  • packages/headless/src/primitives/accordion/accordion-item.tsx
  • packages/headless/src/primitives/accordion/accordion-panel.tsx
  • packages/headless/src/primitives/accordion/accordion-root.tsx
  • packages/headless/src/primitives/accordion/accordion-trigger.tsx
  • packages/headless/src/primitives/autocomplete/autocomplete-input.tsx
  • packages/headless/src/primitives/autocomplete/autocomplete-list.tsx
  • packages/headless/src/primitives/autocomplete/autocomplete-option.tsx
  • packages/headless/src/primitives/autocomplete/autocomplete-popup.tsx
  • packages/headless/src/primitives/autocomplete/autocomplete-positioner.tsx
  • packages/headless/src/primitives/collapsible/collapsible-panel.tsx
  • packages/headless/src/primitives/collapsible/collapsible-root.tsx
  • packages/headless/src/primitives/collapsible/collapsible-trigger.tsx
  • packages/headless/src/primitives/dialog/README.md
  • packages/headless/src/primitives/dialog/dialog-backdrop.tsx
  • packages/headless/src/primitives/dialog/dialog-close.tsx
  • packages/headless/src/primitives/dialog/dialog-description.tsx
  • packages/headless/src/primitives/dialog/dialog-title.tsx
  • packages/headless/src/primitives/dialog/dialog-viewport.tsx
  • packages/headless/src/primitives/drawer/drawer-backdrop.tsx
  • packages/headless/src/primitives/drawer/drawer-close.tsx
  • packages/headless/src/primitives/drawer/drawer-description.tsx
  • packages/headless/src/primitives/drawer/drawer-handle-grip.tsx
  • packages/headless/src/primitives/drawer/drawer-popup.tsx
  • packages/headless/src/primitives/drawer/drawer-title.tsx
  • packages/headless/src/primitives/drawer/drawer-trigger.tsx
  • packages/headless/src/primitives/drawer/drawer-viewport.tsx
  • packages/headless/src/primitives/file-upload/file-upload-dropzone.tsx
  • packages/headless/src/primitives/file-upload/file-upload-item-delete.tsx
  • packages/headless/src/primitives/file-upload/file-upload-item-preview.tsx
  • packages/headless/src/primitives/file-upload/file-upload-item.tsx
  • packages/headless/src/primitives/file-upload/file-upload-root.tsx
  • packages/headless/src/primitives/file-upload/file-upload-trigger.tsx
  • packages/headless/src/primitives/menu/menu-item.tsx
  • packages/headless/src/primitives/menu/menu-popup.tsx
  • packages/headless/src/primitives/menu/menu-positioner.tsx
  • packages/headless/src/primitives/menu/menu-separator.tsx
  • packages/headless/src/primitives/menu/menu-trigger.tsx
  • packages/headless/src/primitives/otp/otp-input.tsx
  • packages/headless/src/primitives/otp/otp-root.tsx
  • packages/headless/src/primitives/popover/popover-close.tsx
  • packages/headless/src/primitives/popover/popover-description.tsx
  • packages/headless/src/primitives/popover/popover-popup.tsx
  • packages/headless/src/primitives/popover/popover-positioner.tsx
  • packages/headless/src/primitives/popover/popover-title.tsx
  • packages/headless/src/primitives/popover/popover-trigger.tsx
  • packages/headless/src/primitives/select/select-option.tsx
  • packages/headless/src/primitives/select/select-popup.tsx
  • packages/headless/src/primitives/select/select-positioner.tsx
  • packages/headless/src/primitives/select/select-trigger.tsx
  • packages/headless/src/primitives/select/select-value.tsx
  • packages/headless/src/primitives/tabs/tabs-indicator.tsx
  • packages/headless/src/primitives/tabs/tabs-list.tsx
  • packages/headless/src/primitives/tabs/tabs-panel.tsx
  • packages/headless/src/primitives/tabs/tabs-tab.tsx
  • packages/headless/src/primitives/tabs/tabs-trigger.tsx
  • packages/headless/src/primitives/tooltip/tooltip-popup.tsx
  • packages/headless/src/primitives/tooltip/tooltip-positioner.tsx
  • packages/headless/src/primitives/tooltip/tooltip-trigger.tsx
🔗 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/clerk-ios (auto-detected)
  • clerk/cli (auto-detected)
  • clerk/clerk-android (auto-detected)

📝 Walkthrough

Walkthrough

The headless primitives replace renderElement with useRender across accordion, autocomplete, collapsible, dialog, drawer, file-upload, menu, OTP, popover, select, tabs, and tooltip components. Manual useMergeRefs usage is replaced by ref arrays passed to useRender. Mounted rendering is handled through enabled and null-element guards, while Composite callbacks extract injected refs explicitly. Documentation and a Changeset entry were updated accordingly.

Estimated code review effort: 4 (Complex) | ~60 minutes

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 0.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly summarizes the main change: migrating the remaining headless primitives to useRender.
Description check ✅ Passed The description is directly related to the changeset and accurately outlines the migration and ref-handling changes.
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.

Warning

Review ran into problems

🔥 Problems

Linked repositories: Couldn't analyze clerk/clerk-android - clone failed: Clone operation failed: Cloning into '/home/jailuser/git'...
warning: templates not found in /usr/share/git-core/templates
From https://github.com/clerk/clerk-android

Errors logged to '/home/jailuser/git/.git/lfs/logs/20260723T223201.601324587.log'.
Use git lfs logs last to view the log.
error: external filter 'git-lfs filter-process' failed
fatal: config/bin/detekt-cli: smudge filter lfs failed
Downloading config/bin/detekt-cli (71 MB)
Error downloading object: config/bin/detekt-cli (2655f48): Smudge error: Error downloading config/bin/detekt-cli (2655f48c7c303a5f9bf920a33229408b8571bb1d29e4e57cf7be3e151bceecb1): LFS: Client error: https://github-cloud.githubusercontent.com/alambic/media/877189286/26/55/2655f48c7c303a5f9bf920a33229408b8571bb1d29e4e57cf7be3e151bceecb1?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIA5BA2674WPWWEFGQ5%2F20260723%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20260723T223321Z&X-Amz-Expires=3600&X-Amz-Signature=38431be9b6664e9dd6fd2c7d6276184b7366a9cbabe3ddab17076c1707c49bf8&X-Amz-SignedHeaders=host&actor_id=136622811&key_id=0&repo_id=980409545&token=1

Errors logged to '/home/jailuser/git/.git/lfs/logs/20260723T223321.746095183.log'.
Use git lfs logs last to view the log.
error: external filter 'git-lfs filter-process' failed
fatal: config/bin/detekt-cli: smudge filter lfs failed


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

@alexcarpenter
alexcarpenter merged commit 499897f into main Jul 23, 2026
49 checks passed
@alexcarpenter
alexcarpenter deleted the carp/mosaic-use-render-pr2 branch July 23, 2026 23:20
Sign up for free to 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