Skip to content

feat(ui): add dialog closedBy dismissal policy - #9366

Merged
maxyinger merged 3 commits into
mainfrom
max/dialog-updates
Aug 12, 2026
Merged

feat(ui): add dialog closedBy dismissal policy#9366
maxyinger merged 3 commits into
mainfrom
max/dialog-updates

Conversation

@maxyinger

Copy link
Copy Markdown
Collaborator

Description

Adds closedBy to the Dialog, controlling which gestures dismiss it. Mirrors the native <dialog closedby> attribute:

Value Escape Outside press Programmatic
any (default)
closerequest
none

A single ordered enum rather than two booleans, so the fourth combination — outside press dismisses but Escape does not — stays unrepresentable.

The five Mosaic dialogs now use closerequest. This fixes a live bug in Destructive, where a stray backdrop click discarded the type-to-confirm input or closed the dialog mid-delete.

trigger on the Mosaic Dialog is now optional, so the machine-driven dialogs stop rendering a button they never use.

Checklist

  • pnpm test runs as expected.
  • pnpm build runs as expected.
  • (If applicable) JSDoc comments have been added or updated for any package exports
  • (If applicable) Documentation has been updated

Type of change

  • 🐛 Bug fix
  • 🌟 New feature
  • 🔨 Breaking change
  • 📖 Refactoring / dependency upgrade / documentation
  • other:

Adds `closedBy: 'any' | 'closerequest' | 'none'` to the headless Dialog root,
driving `escapeKey` and `outsidePress` on `useDismiss`. Defaults to `any`, so
existing callers are unaffected.

The five Mosaic dialogs now use `closerequest`, which stops a stray backdrop
click from discarding the type-to-confirm input in `Destructive` or closing a
dialog mid-request.

`trigger` on the Mosaic `Dialog` becomes optional, so the machine-driven
dialogs no longer render a button they don't use.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@vercel

vercel Bot commented Aug 7, 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 Aug 12, 2026 7:33pm
swingset Ready Ready Preview Aug 12, 2026 7:33pm

Request Review

@changeset-bot

changeset-bot Bot commented Aug 7, 2026

Copy link
Copy Markdown

🦋 Changeset detected

Latest commit: d089e1c

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

@pkg-pr-new

pkg-pr-new Bot commented Aug 7, 2026

Copy link
Copy Markdown

Open in StackBlitz

@clerk/astro

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

@clerk/backend

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

@clerk/chrome-extension

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

@clerk/clerk-js

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

@clerk/electron

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

@clerk/electron-passkeys

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

@clerk/eslint-plugin

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

@clerk/expo

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

@clerk/expo-google-signin

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

@clerk/expo-passkeys

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

@clerk/express

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

@clerk/fastify

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

@clerk/hono

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

@clerk/localizations

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

@clerk/nextjs

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

@clerk/nuxt

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

@clerk/react

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

@clerk/react-router

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

@clerk/shared

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

@clerk/tanstack-react-start

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

@clerk/testing

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

@clerk/ui

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

@clerk/upgrade

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

@clerk/vue

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

commit: d089e1c

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

API Changes Report

Generated by Break Check on 2026-08-12T19:34:24.670Z

Summary

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

No API Changes Detected

All packages have stable APIs with no detected changes.


Report generated by Break Check

Last ran on d089e1c.

@coderabbitai

coderabbitai Bot commented Aug 7, 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: 67559746-9f94-4d1b-a186-3f6bb30f7c12

📥 Commits

Reviewing files that changed from the base of the PR and between 7c1aa99 and d089e1c.

📒 Files selected for processing (1)
  • .changeset/lucky-donuts-invite.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/clerk-ios (auto-detected)
  • clerk/cli (auto-detected)
  • clerk/clerk-android (auto-detected)
💤 Files with no reviewable changes (1)
  • .changeset/lucky-donuts-invite.md

📝 Walkthrough

Walkthrough

The headless dialog adds closedBy modes for Escape and outside-press dismissal. The public type is exported and covered by tests and documentation. Mosaic dialogs accept optional triggers and forward closedBy. Several organization dialogs use closerequest. The dialog story updates backdrop and viewport composition.

Estimated code review effort: 3 (Moderate) | ~20 minutes

Possibly related PRs

  • clerk/javascript#9388: Both PRs modify Dialog.Root and Mosaic dialog consumers to add and use the closedBy dismissal policy, including optional triggers.
  • clerk/javascript#9420: Both PRs introduce the closedBy API and dismissal behavior changes in the headless and Mosaic dialog implementations.

Suggested reviewers: austincalvelage

🚥 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 and concisely describes the new Dialog closedBy dismissal policy.
Description check ✅ Passed The description directly explains the closedBy feature, its dismissal behavior, and related Mosaic dialog 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.

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

@coderabbitai coderabbitai Bot 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 `@packages/headless/src/primitives/dialog/dialog-root.tsx`:
- Around line 21-31: Update the shared closedBy='none' contract in
packages/headless/src/primitives/dialog/dialog-root.tsx lines 21-31,
packages/headless/src/primitives/dialog/README.md lines 74-94, and
.changeset/lucky-donuts-invite.md line 5: state that Escape and outside-press
dismissal are disabled while explicit close controls such as Dialog.Close remain
available. Use consistent wording across all three sites.
🪄 Autofix

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: 16d1a9d7-2fb9-415c-8aef-4a6c79b99611

📥 Commits

Reviewing files that changed from the base of the PR and between 6100719 and 38e7c1f.

📒 Files selected for processing (14)
  • .changeset/lucky-donuts-invite.md
  • packages/headless/src/primitives/dialog/README.md
  • packages/headless/src/primitives/dialog/dialog-root.tsx
  • packages/headless/src/primitives/dialog/dialog.test.tsx
  • packages/headless/src/primitives/dialog/index.ts
  • packages/headless/src/primitives/dialog/parts.ts
  • packages/swingset/src/stories/dialog.mdx
  • packages/swingset/src/stories/dialog.stories.tsx
  • packages/ui/src/mosaic/block/destructive.tsx
  • packages/ui/src/mosaic/components/dialog.tsx
  • packages/ui/src/mosaic/organization/organization-profile-domains-section-add-verify.view.tsx
  • packages/ui/src/mosaic/organization/organization-profile-domains-section-enrollment.view.tsx
  • packages/ui/src/mosaic/organization/organization-profile-domains-section-remove.view.tsx
  • packages/ui/src/mosaic/organization/organization-profile-profile-section.view.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)

Comment thread packages/headless/src/primitives/dialog/dialog-root.tsx
@coderabbitai

coderabbitai Bot commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Note

GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer.

@maxyinger
maxyinger merged commit dfc9c0d into main Aug 12, 2026
111 of 118 checks passed
@maxyinger
maxyinger deleted the max/dialog-updates branch August 12, 2026 20:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants