chore: dialog and dialog container to ui

[MichaelUnkey]

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps use understand why this PR exists

Type of change

• [ ] Bug fix (non-breaking change which fixes an issue)
• [x] Chore (refactoring code, technical debt, workflow improvements)
• [ ] Enhancement (small improvements)
• [ ] New feature (non-breaking change which adds functionality)
• [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
• [ ] This change requires a documentation update

How should this be tested?

• All Dialogs that used the <DialogContainer /> still function and look as they should

Checklist

Required

• [x] Filled out the "How to test" section in this PR
• [x] Read Contributing Guide
• [x] Self-reviewed my own code
• [x] Commented on my code in hard-to-understand areas
• [x] Ran pnpm build
• [x] Ran pnpm fmt
• [x] Checked for warnings, there are none
• [x] Removed all console.logs
• [x] Merged the latest changes from main onto my branch with git pull origin main
• [x] My changes don't cause any responsiveness issues

Appreciated

• [ ] If a UI change was made: Added a screen recording or screenshots to this PR
• [ ] Updated the Unkey Docs if changes were necessary

Summary by CodeRabbit

• New Features

  • Introduced a customizable Dialog Container component and supporting dialog UI parts for consistent modal dialogs across the app.
  • Added a dialog demonstration example and comprehensive documentation for usage and props.

• Chores

  • Updated internal dependencies to include a dialog UI library.
  • Updated imports throughout the dashboard to use the new dialog component from the shared UI library, ensuring consistency and maintainability.

[changeset-bot[bot]]

⚠️ No Changeset found

Latest commit: 4a695549774ae375f13f506afed69cbb5c5d27a2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

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

Click here to learn what changesets are, and how to add one.

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

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
dashboard	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 5, 2025 11:38pm
engineering	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 5, 2025 11:38pm

[coderabbitai[bot]]

[!IMPORTANT]

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

📝 Walkthrough

Walkthrough

This change migrates all usages of the DialogContainer component in the dashboard application from a local implementation to the external @unkey/ui package. It introduces a new dialog system within the internal/ui package, including the DialogContainer component, reusable dialog parts, and a set of dialog primitives built on Radix UI. Documentation and example usage for the new dialog container are also added. The @radix-ui/react-dialog dependency is included in the design system to support the new components. No changes to logic or control flow occur in the consuming files; the update is limited to import paths and the introduction of the new dialog implementation.

Changes

Files/Group	Change Summary
apps/dashboard/app/(app)/apis/[apiId]/settings/components/delete-api.tsx delete-protection.tsx authorization/_components/rbac-form.tsx authorization/permissions/[permissionId]/delete-permission.tsx authorization/roles/[roleId]/delete-role.tsx ratelimits/[namespaceId]/_components/delete-dialog.tsx ratelimits/[namespaceId]/_components/identifier-dialog.tsx ratelimits/[namespaceId]/_components/namespace-delete-dialog.tsx ratelimits/_components/create-namespace-button.tsx settings/billing/components/confirmation.tsx settings/team/invite.tsx auth/sign-in/org-selector.tsx	Changed the import source of DialogContainer from a local path to the external @unkey/ui package. No other code or logic was modified in these files.
apps/engineering/content/design/components/dialog-container.example.tsx	Added a new example React component DialogContainerExample demonstrating usage of the dialog container, including state management and UI composition for documentation/demo purposes.
apps/engineering/content/design/components/dialog-container.mdx	Added new documentation file describing the Dialog Container component, its features, usage example, and a detailed props table.
internal/ui/package.json	Added @radix-ui/react-dialog as a new dependency.
internal/ui/src/components/dialog/dialog-container.tsx	Introduced new DialogContainer React component with customizable header, content, and footer, using Radix UI dialog primitives and default dialog parts. Exports dialog container and its parts.
internal/ui/src/components/dialog/dialog-parts.tsx	Added new reusable dialog UI parts: DefaultDialogHeader, DefaultDialogContentArea, and DefaultDialogFooter, each with customizable props and styling.
internal/ui/src/components/dialog/dialog.tsx	Added new dialog primitives built on Radix UI: Dialog, DialogTrigger, DialogPortal, DialogClose, DialogOverlay, DialogContent, DialogHeader, DialogFooter, DialogTitle, and DialogDescription. Includes support for close warnings and ref forwarding.
internal/ui/src/index.ts	Added export for dialog-container and its parts to the package index.

Sequence Diagram(s)

sequenceDiagram
    participant ConsumerComponent as Any Dashboard Component
    participant @unkey/ui as @unkey/ui/DialogContainer
    participant RadixDialog as Radix UI Dialog Primitives

    ConsumerComponent->>@unkey/ui: Import DialogContainer
    ConsumerComponent->>@unkey/ui: Render <DialogContainer ...props />
    @unkey/ui->>RadixDialog: Use Radix Dialog primitives for modal logic
    @unkey/ui->>ConsumerComponent: Render dialog with header, content, footer, and handle open/close events

Possibly related PRs

• unkeyed/unkey#2667: Introduced the new DialogContainer component and dialog parts in the design system, which are now being adopted in this PR.

Suggested reviewers

• perkinsjr
• chronark
• mcstepp

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[github-actions[bot]]

Thank you for following the naming conventions for pull request titles! 🙏

[ogzhanolguncu]

We should also add NavigableDialog(Dialog that we use for Create Key) here too. I'm not sure about the name tho. If you have a better name for it we can do that. And, maybe we should make it part of regular Dialog and make them more composable. Let's discuss that tomorrow.