fix(navbar): hide overlay when menu is closed

[Peterl561]

Closes eng-1823

📝 Description

• Overlay is used to provide a focus scope for child components
  • this is useful for things like modals and popovers
  • should only be applied to the page when the child with focus scope is open
• NavbarMenu applies Overlay to page even though its closed
  • this causes other Overlay components like Select and Autocomplete to behave as if they are in a modal
• this PR makes it so Overlay is only applied by NavbarMenu when it is open

⛳️ Current behavior (updates)

Note that it takes 2 clicks: one to close current Select and one to open a different Select

before.mp4

🚀 New behavior

1 click to close current Select and open a different Select

after.mp4

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

No

📝 Additional Information

Summary by CodeRabbit

• Bug Fixes
  • Corrected NavbarMenu component behavior to prevent overlay rendering when the menu is closed
  • Improved conditional rendering of overlay in the navigation menu component

The changes ensure a more precise and controlled display of the navigation menu, enhancing the user interface's responsiveness and visual consistency.

[changeset-bot]

🦋 Changeset detected

Latest commit: 717f4da

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 4, 2025 1:49am
nextui-storybook-v2	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jan 4, 2025 1:49am

[linear]

ENG-1823 [Bug] NavbarMenu applys Overlay to page when closed

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

A patch has been applied to the @nextui-org/navbar package, focusing on the NavbarMenu component. The key modification involves adjusting the rendering of the Overlay component based on the menu's open state. When the menu is closed, the Overlay is no longer applied, improving the component's behavior and rendering logic.

Changes

File	Change Summary
packages/components/navbar/src/navbar-menu.tsx	- Added React import - Conditionally render Overlay based on isMenuOpen state - Simplified rendering logic for menu contents - Ensured Overlay is only applied when menu is open

Suggested reviewers

• wingkwong
• jrgarciadev

Possibly related PRs

• fix: navbar state change #4406: PR addressing issues with the Navbar component and NavbarMenu, which shares similarities with the current changes

---

📜 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 ef916ea and 717f4da.

📒 Files selected for processing (2)

• .changeset/honest-waves-camp.md (1 hunks)
• packages/components/navbar/src/navbar-menu.tsx (2 hunks)

---

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.