fix(navbar): remove NavbarMenu when closed

[Peterl561]

Closes #4501

📝 Description

• if animation is enabled, NavbarMenu is not in the DOM when menu is closed
• if animation is disabled, NavbarMenu is in the DOM but has display: none
• could not think of any particular reason not to remove NavbarMenu from DOM when menu is closed
  • shouldn't affect accessibility since it was using display: none when closed

⛳️ Current behavior (updates)

no actual behaviour changes

🚀 New behavior

no actual behaviour changes, console error fixed

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

No

📝 Additional Information

Summary by CodeRabbit

• Bug Fixes
  • Resolved an error in the NavbarMenu component of the @nextui-org/navbar package
  • Fixed rendering issues when animations are disabled
  • Improved component stability and rendering logic

[changeset-bot]

🦋 Changeset detected

Latest commit: a40bc95

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

This PR includes changesets to release 2 packages

Name	Type
@nextui-org/navbar	Patch
@nextui-org/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)
nextui-docs-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 7, 2025 6:28am
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 7, 2025 6:28am

[coderabbitai]

Walkthrough

A patch has been introduced for the @nextui-org/navbar package to resolve a React prop error in the NavbarMenu component. The changes modify the rendering logic to handle scenarios where animations are disabled, specifically addressing an issue with portalContainer prop being incorrectly passed to a React.Fragment. The implementation now ensures that the component renders correctly under different animation and menu open states.

Changes

File	Change Summary
packages/components/navbar/src/navbar-menu.tsx	Refactored rendering logic for NavbarMenu component to handle disableAnimation and isMenuOpen states more efficiently
.changeset/nice-beds-battle.md	Patch file for the @nextui-org/navbar package

Assessment against linked issues

Objective	Addressed	Explanation
Resolve React error about portalContainer [#4501]	✅
Prevent invalid prop errors in NavbarMenu	✅

Possibly related PRs

• fix: navbar state change #4406: Previous PR addressing issues with the @nextui-org/navbar package and NavbarMenu component

Suggested reviewers

• wingkwong
• jrgarciadev

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ 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.

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. (Beta)
• @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: 0

🧹 Nitpick comments (2)

packages/components/navbar/src/navbar-menu.tsx (2)

45-46: Consider removing the ts-expect-error.

Instead of suppressing the TypeScript error, consider defining a proper type for the style object that includes the custom CSS variable.

-            // @ts-expect-error
-            "--navbar-height": typeof height === "number" ? `${height}px` : height,
+            ["--navbar-height" as string]: typeof height === "number" ? `${height}px` : height,

---

44-51: Consider extracting shared styles to reduce duplication.

The navbar height style logic is duplicated between the animated and non-animated versions. Consider extracting it to a shared object or function.

const getNavbarStyles = (height: number | string, additionalStyles = {}) => ({
  ["--navbar-height" as string]: typeof height === "number" ? `${height}px` : height,
  ...additionalStyles,
});

Also applies to: 82-89

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between eada8cb and a40bc95.

📒 Files selected for processing (2)

• .changeset/nice-beds-battle.md (1 hunks)
• packages/components/navbar/src/navbar-menu.tsx (1 hunks)

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

• GitHub Check: TypeScript
• GitHub Check: Build

🔇 Additional comments (2)

packages/components/navbar/src/navbar-menu.tsx (1)

35-54: LGTM! Clean implementation of the non-animated menu.

The implementation correctly handles the disabled animation case by removing the menu from DOM when closed and using data attributes for visibility control when open.

.changeset/nice-beds-battle.md (1)

1-5: LGTM! Clear and accurate changeset.

The changeset correctly describes the patch and references the fixed issue.