fix(tabs): unresponsive modal after switching tabs inside

[wingkwong]

Closes #5543

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

💣 Is this a breaking change (Yes/No):

📝 Additional Information

Summary by CodeRabbit

• Bug Fixes

  • Resolved an issue where a modal became unresponsive after switching tabs.
  • Disabled tab cursor and layout group animations when tabs are used inside a modal to prevent interaction issues.

• Tests

  • Added a test to ensure tabs within a modal remain functional when the modal is reopened.

• Chores

  • Updated development dependencies to include necessary modal and tab packages.

[linear]

ENG-2698 [BUG] - Tabs components inside Modal causes the app unresponsive

[changeset-bot]

🦋 Changeset detected

Latest commit: 95db501

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

This PR includes changesets to release 2 packages

Name	Type
@heroui/tabs	Patch
@heroui/react	Patch

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

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

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
heroui	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 6, 2025 3:24pm
heroui-sb	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 6, 2025 3:24pm

[coderabbitai]

Walkthrough

The changes address an issue where using the Tabs component inside a Modal caused the app to become unresponsive after switching tabs and reopening the modal. The update disables certain tab animations when rendered inside a modal and adds a test to verify correct modal-tab interaction. Dependencies are updated accordingly.

Changes

Cohort / File(s)	Change Summary
Changelog .changeset/nine-moles-sort.md	Adds a patch note describing the fix for modal responsiveness when switching tabs inside a modal.
Tabs Component Logic .../tabs/src/tab.tsx, .../tabs/src/tabs.tsx	Disables animated cursor and layout group animation for tabs rendered inside a modal by detecting modal context.
Tabs Test .../tabs/__tests__/tabs.test.tsx	Adds a new test ensuring that reopening a modal with tabs does not block UI or cause stale state issues.
Package Configuration .../tabs/package.json	Adds @heroui/modal as a devDependency for testing and development purposes.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant Modal
    participant Tabs

    User->>App: Clicks button to open modal
    App->>Modal: Opens modal
    Modal->>Tabs: Renders Tabs inside modal
    User->>Tabs: Switches tab
    Tabs->>Tabs: Updates selected tab (no animation if in modal)
    User->>Modal: Clicks close
    Modal->>App: Modal unmounts
    User->>App: Clicks button to reopen modal
    App->>Modal: Opens modal again
    Modal->>Tabs: Renders Tabs (state is correct, no freeze)

Loading

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~15 minutes

Assessment against linked issues

Objective	Addressed	Explanation
Fix unresponsive app when switching tabs inside Modal and reopening it (#5543)	✅
Ensure modal closes and reopens correctly after tab interaction (#5543)	✅
Prevent animation or state issues with Tabs inside Modal (#5543)	✅

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes found.

Suggested reviewers

• jrgarciadev

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06ec73c and 95db501.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (1)

• packages/components/tabs/package.json (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• packages/components/tabs/package.json

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: Continuous Release
• GitHub Check: Prettier
• GitHub Check: ESLint
• GitHub Check: TypeScript
• GitHub Check: Build

✨ Finishing Touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch fix/eng-2698

---

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.
  • Explain this complex logic.
  • 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 explain this code block.
• 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 explain its main purpose.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

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

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 generate unit tests to generate unit tests for 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.

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.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

packages/components/tabs/__tests__/tabs.test.tsx (1)

441-541: LGTM - Comprehensive test coverage for modal-tab interaction bug.

The test case thoroughly covers the exact scenario from issue #5543: opening modal, switching tabs, closing modal, and reopening. The test properly uses async utilities and verifies that tab selection works correctly after modal reopening.

Consider enhancing the test to be more explicit about what constitutes "blocking":

+    // Verify no JavaScript errors or frozen state by testing additional interactions
+    await act(async () => {
+      fireEvent.click(newTabButtons[0]); // Switch back to first tab
+    });
+    
+    await waitFor(() => {
+      expect(newTabButtons[0]).toHaveAttribute("aria-selected", "true");
+    });

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8e51a85 and 06ec73c.

⛔ Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

📒 Files selected for processing (5)

• .changeset/nine-moles-sort.md (1 hunks)
• packages/components/tabs/__tests__/tabs.test.tsx (2 hunks)
• packages/components/tabs/package.json (1 hunks)
• packages/components/tabs/src/tab.tsx (2 hunks)
• packages/components/tabs/src/tabs.tsx (2 hunks)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (5)

• GitHub Check: Tests
• GitHub Check: Prettier
• GitHub Check: Continuous Release
• GitHub Check: ESLint
• GitHub Check: TypeScript

🔇 Additional comments (8)

packages/components/tabs/package.json (1)

64-64: LGTM - Modal dependency addition is justified.

The addition of @heroui/modal as a devDependency is appropriate since the new test case imports Modal components to verify modal-tab interactions.

.changeset/nine-moles-sort.md (1)

1-6: LGTM - Changeset properly documents the fix.

The changeset correctly identifies this as a patch-level change with a clear description that matches the PR objectives and references the correct issue number.

packages/components/tabs/src/tab.tsx (2)

79-79: LGTM - Modal detection logic is sound.

The isInModal detection correctly uses the standard aria-modal="true" attribute and safely handles potential null references with optional chaining.

---

125-125: LGTM - Cursor animation disabled in modals addresses the core issue.

Adding !isInModal to the animation condition is a targeted fix that prevents cursor animation issues inside modals while preserving normal behavior elsewhere.

packages/components/tabs/src/tabs.tsx (3)

24-24: LGTM - domRef destructuring enables modal detection.

The addition of domRef destructuring is necessary for the modal detection functionality.

---

36-36: LGTM - Consistent modal detection approach.

The isInModal detection uses the same reliable logic as in tab.tsx, ensuring consistent behavior across components.

---

38-38: LGTM - LayoutGroup disabled in modals prevents animation conflicts.

Disabling the LayoutGroup animation when tabs are inside modals addresses the core issue where framer-motion animations were interfering with modal DOM cleanup, causing unresponsiveness.

packages/components/tabs/__tests__/tabs.test.tsx (1)

5-10: LGTM - Import additions support the new test case.

The new imports are appropriately scoped for testing modal-tab interactions: act, waitFor for async handling, and Modal/Button components for building the test scenario.

[pkg-pr-new]

Open in StackBlitz

@heroui/accordion

npm i https://pkg.pr.new/@heroui/accordion@5582

@heroui/alert

npm i https://pkg.pr.new/@heroui/alert@5582

@heroui/autocomplete

npm i https://pkg.pr.new/@heroui/autocomplete@5582

@heroui/avatar

npm i https://pkg.pr.new/@heroui/avatar@5582

@heroui/badge

npm i https://pkg.pr.new/@heroui/badge@5582

@heroui/breadcrumbs

npm i https://pkg.pr.new/@heroui/breadcrumbs@5582

@heroui/button

npm i https://pkg.pr.new/@heroui/button@5582

@heroui/calendar

npm i https://pkg.pr.new/@heroui/calendar@5582

@heroui/card

npm i https://pkg.pr.new/@heroui/card@5582

@heroui/checkbox

npm i https://pkg.pr.new/@heroui/checkbox@5582

@heroui/chip

npm i https://pkg.pr.new/@heroui/chip@5582

@heroui/code

npm i https://pkg.pr.new/@heroui/code@5582

@heroui/date-input

npm i https://pkg.pr.new/@heroui/date-input@5582

@heroui/date-picker

npm i https://pkg.pr.new/@heroui/date-picker@5582

@heroui/divider

npm i https://pkg.pr.new/@heroui/divider@5582

@heroui/drawer

npm i https://pkg.pr.new/@heroui/drawer@5582

@heroui/dropdown

npm i https://pkg.pr.new/@heroui/dropdown@5582

@heroui/form

npm i https://pkg.pr.new/@heroui/form@5582

@heroui/image

npm i https://pkg.pr.new/@heroui/image@5582

@heroui/input

npm i https://pkg.pr.new/@heroui/input@5582

@heroui/input-otp

npm i https://pkg.pr.new/@heroui/input-otp@5582

@heroui/kbd

npm i https://pkg.pr.new/@heroui/kbd@5582

@heroui/link

npm i https://pkg.pr.new/@heroui/link@5582

@heroui/listbox

npm i https://pkg.pr.new/@heroui/listbox@5582

@heroui/menu

npm i https://pkg.pr.new/@heroui/menu@5582

@heroui/modal

npm i https://pkg.pr.new/@heroui/modal@5582

@heroui/navbar

npm i https://pkg.pr.new/@heroui/navbar@5582

@heroui/number-input

npm i https://pkg.pr.new/@heroui/number-input@5582

@heroui/pagination

npm i https://pkg.pr.new/@heroui/pagination@5582

@heroui/popover

npm i https://pkg.pr.new/@heroui/popover@5582

@heroui/progress

npm i https://pkg.pr.new/@heroui/progress@5582

@heroui/radio

npm i https://pkg.pr.new/@heroui/radio@5582

@heroui/ripple

npm i https://pkg.pr.new/@heroui/ripple@5582

@heroui/scroll-shadow

npm i https://pkg.pr.new/@heroui/scroll-shadow@5582

@heroui/select

npm i https://pkg.pr.new/@heroui/select@5582

@heroui/skeleton

npm i https://pkg.pr.new/@heroui/skeleton@5582

@heroui/slider

npm i https://pkg.pr.new/@heroui/slider@5582

@heroui/snippet

npm i https://pkg.pr.new/@heroui/snippet@5582

@heroui/spacer

npm i https://pkg.pr.new/@heroui/spacer@5582

@heroui/spinner

npm i https://pkg.pr.new/@heroui/spinner@5582

@heroui/switch

npm i https://pkg.pr.new/@heroui/switch@5582

@heroui/table

npm i https://pkg.pr.new/@heroui/table@5582

@heroui/tabs

npm i https://pkg.pr.new/@heroui/tabs@5582

@heroui/toast

npm i https://pkg.pr.new/@heroui/toast@5582

@heroui/tooltip

npm i https://pkg.pr.new/@heroui/tooltip@5582

@heroui/user

npm i https://pkg.pr.new/@heroui/user@5582

@heroui/react

npm i https://pkg.pr.new/@heroui/react@5582

@heroui/system

npm i https://pkg.pr.new/@heroui/system@5582

@heroui/system-rsc

npm i https://pkg.pr.new/@heroui/system-rsc@5582

@heroui/theme

npm i https://pkg.pr.new/@heroui/theme@5582

@heroui/use-aria-accordion

npm i https://pkg.pr.new/@heroui/use-aria-accordion@5582

@heroui/use-aria-accordion-item

npm i https://pkg.pr.new/@heroui/use-aria-accordion-item@5582

@heroui/use-aria-button

npm i https://pkg.pr.new/@heroui/use-aria-button@5582

@heroui/use-aria-link

npm i https://pkg.pr.new/@heroui/use-aria-link@5582

@heroui/use-aria-modal-overlay

npm i https://pkg.pr.new/@heroui/use-aria-modal-overlay@5582

@heroui/use-aria-multiselect

npm i https://pkg.pr.new/@heroui/use-aria-multiselect@5582

@heroui/use-aria-overlay

npm i https://pkg.pr.new/@heroui/use-aria-overlay@5582

@heroui/use-callback-ref

npm i https://pkg.pr.new/@heroui/use-callback-ref@5582

@heroui/use-clipboard

npm i https://pkg.pr.new/@heroui/use-clipboard@5582

@heroui/use-data-scroll-overflow

npm i https://pkg.pr.new/@heroui/use-data-scroll-overflow@5582

@heroui/use-disclosure

npm i https://pkg.pr.new/@heroui/use-disclosure@5582

@heroui/use-draggable

npm i https://pkg.pr.new/@heroui/use-draggable@5582

@heroui/use-form-reset

npm i https://pkg.pr.new/@heroui/use-form-reset@5582

@heroui/use-image

npm i https://pkg.pr.new/@heroui/use-image@5582

@heroui/use-infinite-scroll

npm i https://pkg.pr.new/@heroui/use-infinite-scroll@5582

@heroui/use-intersection-observer

npm i https://pkg.pr.new/@heroui/use-intersection-observer@5582

@heroui/use-is-mobile

npm i https://pkg.pr.new/@heroui/use-is-mobile@5582

@heroui/use-is-mounted

npm i https://pkg.pr.new/@heroui/use-is-mounted@5582

@heroui/use-measure

npm i https://pkg.pr.new/@heroui/use-measure@5582

@heroui/use-pagination

npm i https://pkg.pr.new/@heroui/use-pagination@5582

@heroui/use-real-shape

npm i https://pkg.pr.new/@heroui/use-real-shape@5582

@heroui/use-ref-state

npm i https://pkg.pr.new/@heroui/use-ref-state@5582

@heroui/use-resize

npm i https://pkg.pr.new/@heroui/use-resize@5582

@heroui/use-safe-layout-effect

npm i https://pkg.pr.new/@heroui/use-safe-layout-effect@5582

@heroui/use-scroll-position

npm i https://pkg.pr.new/@heroui/use-scroll-position@5582

@heroui/use-ssr

npm i https://pkg.pr.new/@heroui/use-ssr@5582

@heroui/use-theme

npm i https://pkg.pr.new/@heroui/use-theme@5582

@heroui/use-update-effect

npm i https://pkg.pr.new/@heroui/use-update-effect@5582

@heroui/use-viewport-size

npm i https://pkg.pr.new/@heroui/use-viewport-size@5582

@heroui/aria-utils

npm i https://pkg.pr.new/@heroui/aria-utils@5582

@heroui/dom-animation

npm i https://pkg.pr.new/@heroui/dom-animation@5582

@heroui/framer-utils

npm i https://pkg.pr.new/@heroui/framer-utils@5582

@heroui/react-rsc-utils

npm i https://pkg.pr.new/@heroui/react-rsc-utils@5582

@heroui/react-utils

npm i https://pkg.pr.new/@heroui/react-utils@5582

@heroui/shared-icons

npm i https://pkg.pr.new/@heroui/shared-icons@5582

@heroui/shared-utils

npm i https://pkg.pr.new/@heroui/shared-utils@5582

@heroui/stories-utils

npm i https://pkg.pr.new/@heroui/stories-utils@5582

@heroui/test-utils

npm i https://pkg.pr.new/@heroui/test-utils@5582

commit: 95db501