fix(accordion): keepContentMounted with disableAnimation by wingkwong · Pull Request #5172 · heroui-inc/heroui

wingkwong · 2025-04-09T17:01:49Z

Closes #5157

📝 Description

currently disableAnimation bypass keepContentMounted logic. This PR is to cover it.

⛳️ Current behavior (updates)

The content is mounted no matter keepContentMounted is true or false.

🚀 New behavior

The content is mounted only when keepContentMounted is true.

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

No

📝 Additional Information

Summary by CodeRabbit

Bug Fixes
- Improved the accordion’s behavior to properly manage content display when animations are disabled. Content is now conditionally rendered based on the keepContentMounted setting, ensuring it appears only when expected.
Tests
- Expanded test coverage to verify the accordion’s performance under different configurations, ensuring consistent behavior whether content is pre-mounted or loaded on interaction.

linear · 2025-04-09T17:01:52Z

ENG-2386 [BUG] - Accordion: disableAnimation prevents keepContentMounted from being set to false

changeset-bot · 2025-04-09T17:01:53Z

🦋 Changeset detected

Latest commit: dd01d0e

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

This PR includes changesets to release 2 packages

Name	Type
@heroui/accordion	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 · 2025-04-09T17:01:54Z

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	Apr 10, 2025 1:11pm
heroui-sb	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Apr 10, 2025 1:11pm

coderabbitai · 2025-04-09T17:01:56Z

Walkthrough

This pull request introduces a patch for the @heroui/accordion package to address an issue where the disableAnimation prop was incorrectly bypassing the keepContentMounted check. The patch updates the rendering logic in the accordion item component and enhances the test coverage to validate the correct conditional mounting of content based on the keepContentMounted and disableAnimation props.

Changes

File(s)	Change Summary
`.changeset/smooth-bears-leave.md`	Patch for the `@heroui/accordion` package addressing issue [#5157] by correcting the behavior of `keepContentMounted` when paired with `disableAnimation`.
`packages/components/accordion/__tests__/accordion.test.tsx`, `packages/components/accordion/src/accordion-item.tsx`	Added conditional rendering in the AccordionItem component to check `keepContentMounted` in combination with `disableAnimation`; introduced additional tests to cover multiple scenarios (content mounting based on prop combinations and interaction).

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant A as Accordion
    participant AI as AccordionItem

    U->>A: Clicks to toggle accordion item
    A->>AI: Pass props (isOpen, keepContentMounted, disableAnimation)
    Note over AI: Evaluate rendering conditions:
    AI->>AI: Check if disableAnimation is enabled
    alt disableAnimation is true and keepContentMounted is true
        AI->>AI: Render content unconditionally
    else disableAnimation is true and keepContentMounted is false
        AI->>AI: Render content only if isOpen is true
    else
        AI->>AI: Use default animated rendering logic
    end

Assessment against linked issues

Objective	Addressed	Explanation
Ensure `disableAnimation` does not override the `keepContentMounted` behavior (#5157)	✅

Suggested reviewers

jrgarciadev

📜 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 d3ca655 and dd01d0e.

📒 Files selected for processing (1)

packages/components/accordion/__tests__/accordion.test.tsx (3 hunks)

⏰ Context from checks skipped due to timeout of 90000ms (3)

GitHub Check: TypeScript
GitHub Check: Continuous Release
GitHub Check: Build

🔇 Additional comments (6)

packages/components/accordion/__tests__/accordion.test.tsx (6)

3-3: Appropriate import addition for asynchronous testing

Adding waitFor from @testing-library/react is a good improvement for handling asynchronous component rendering in the tests.

270-270: Clear test naming improvement

Renaming the test to explicitly mention keepContentMounted={true} improves clarity and readability by precisely stating what's being tested.

293-296: Good use of waitFor for async assertions

Adding waitFor enhances test reliability by ensuring assertions are only made after DOM updates have completed.

299-326: Well-implemented test case for keepContentMounted={false}

This test case properly verifies that content is not mounted initially when keepContentMounted is set to false, and that only the expanded item's content is present in the DOM after interaction.

328-355: Comprehensive test for keepContentMounted with disableAnimation

This test effectively validates that when both keepContentMounted={true} and disableAnimation={true} are set, content remains mounted regardless of the accordion's expanded state.

357-383: Complete validation of keepContentMounted={false} with disableAnimation

This test accurately verifies that even when disableAnimation={true} is set, the keepContentMounted={false} behavior is preserved, ensuring content is only mounted when its item is expanded.

✨ Finishing Touches

📝 Generate Docstrings

🪧 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.

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 resolve resolve all the CodeRabbit review comments.
@coderabbitai plan to trigger planning for file edits and PR creation.
@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.

pkg-pr-new · 2025-04-09T17:08:37Z

Open in StackBlitz

@heroui/accordion

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

@heroui/autocomplete

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

@heroui/alert

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

@heroui/avatar

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

@heroui/badge

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

@heroui/breadcrumbs

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

@heroui/button

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

@heroui/calendar

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

@heroui/card

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

@heroui/checkbox

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

@heroui/chip

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

@heroui/code

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

@heroui/date-input

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

@heroui/date-picker

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

@heroui/divider

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

@heroui/drawer

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

@heroui/dropdown

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

@heroui/form

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

@heroui/input

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

@heroui/image

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

@heroui/input-otp

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

@heroui/link

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

@heroui/kbd

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

@heroui/listbox

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

@heroui/menu

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

@heroui/modal

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

@heroui/navbar

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

@heroui/number-input

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

@heroui/pagination

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

@heroui/popover

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

@heroui/progress

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

@heroui/radio

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

@heroui/ripple

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

@heroui/scroll-shadow

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

@heroui/select

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

@heroui/skeleton

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

@heroui/slider

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

@heroui/snippet

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

@heroui/spacer

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

@heroui/spinner

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

@heroui/switch

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

@heroui/table

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

@heroui/tabs

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

@heroui/toast

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

@heroui/tooltip

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

@heroui/user

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

@heroui/react

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

@heroui/system

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

@heroui/system-rsc

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

@heroui/theme

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

@heroui/use-aria-accordion

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

@heroui/use-aria-accordion-item

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

@heroui/use-aria-button

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

@heroui/use-aria-link

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

@heroui/use-aria-modal-overlay

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

@heroui/use-aria-multiselect

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

@heroui/use-callback-ref

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

@heroui/use-clipboard

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

@heroui/use-data-scroll-overflow

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

@heroui/use-disclosure

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

@heroui/use-draggable

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

@heroui/use-image

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

@heroui/use-infinite-scroll

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

@heroui/use-intersection-observer

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

@heroui/use-is-mobile

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

@heroui/use-is-mounted

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

@heroui/use-measure

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

@heroui/use-pagination

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

@heroui/use-real-shape

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

@heroui/use-ref-state

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

@heroui/use-resize

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

@heroui/use-safe-layout-effect

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

@heroui/use-scroll-position

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

@heroui/use-ssr

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

@heroui/use-theme

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

@heroui/use-update-effect

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

@heroui/aria-utils

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

@heroui/dom-animation

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

@heroui/framer-utils

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

@heroui/react-rsc-utils

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

@heroui/react-utils

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

@heroui/shared-icons

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

@heroui/stories-utils

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

@heroui/shared-utils

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

@heroui/test-utils

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

commit: dd01d0e

see: heroui-inc/heroui#5172

wingkwong added 2 commits April 10, 2025 00:58

fix(accordion): keepContentMounted with disableAnimation

da8958b

feat(accordion): add test cases

d3ca655

wingkwong requested a review from jrgarciadev as a code owner April 9, 2025 17:01

wingkwong added this to the v2.7.7 milestone Apr 9, 2025

vercel Bot deployed to Preview – heroui-sb April 9, 2025 17:02 View deployment

wingkwong assigned jrgarciadev Apr 9, 2025

vercel Bot deployed to Preview – heroui April 9, 2025 17:04 View deployment

fix(accordion): use waitFor

dd01d0e

vercel Bot deployed to Preview – heroui-sb April 10, 2025 13:09 View deployment

vercel Bot deployed to Preview – heroui April 10, 2025 13:11 View deployment

AnYiEE added a commit to AnYiEE/touhou-mystia-izakaya-assistant that referenced this pull request Apr 18, 2025

fix(components/accordion): keepContentMounted with disableAnimation

61498c9

see: heroui-inc/heroui#5172

jrgarciadev merged commit 531518f into canary Apr 19, 2025
10 checks passed

jrgarciadev deleted the fix/eng-2386 branch April 19, 2025 15:24

github-actions Bot mentioned this pull request Apr 19, 2025

ci(changesets): 📦 version packages #5218

Merged

github-actions Bot mentioned this pull request Apr 28, 2025

ci(changesets): 📦 version packages #5249

Merged

coderabbitai Bot mentioned this pull request Oct 18, 2025

feat(accordion): add transitionDuration and scrollOnOpen props #5828

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(accordion): keepContentMounted with disableAnimation#5172

fix(accordion): keepContentMounted with disableAnimation#5172
jrgarciadev merged 3 commits into
canaryfrom
fix/eng-2386

wingkwong commented Apr 9, 2025 •

edited by coderabbitai Bot

Loading

Uh oh!

linear Bot commented Apr 9, 2025

Uh oh!

changeset-bot Bot commented Apr 9, 2025 •

edited

Loading

Uh oh!

vercel Bot commented Apr 9, 2025 •

edited

Loading

Uh oh!

coderabbitai Bot commented Apr 9, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

pkg-pr-new Bot commented Apr 9, 2025 •

edited

Loading

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

wingkwong commented Apr 9, 2025 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📝 Description

⛳️ Current behavior (updates)

🚀 New behavior

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

📝 Additional Information

Summary by CodeRabbit

Uh oh!

linear Bot commented Apr 9, 2025

Uh oh!

changeset-bot Bot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

vercel Bot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai Bot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

Uh oh!

pkg-pr-new Bot commented Apr 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

wingkwong commented Apr 9, 2025 •

edited by coderabbitai Bot

Loading

changeset-bot Bot commented Apr 9, 2025 •

edited

Loading

vercel Bot commented Apr 9, 2025 •

edited

Loading

coderabbitai Bot commented Apr 9, 2025 •

edited

Loading

pkg-pr-new Bot commented Apr 9, 2025 •

edited

Loading