Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat direct control navbar-menu #2547

Open
wants to merge 1 commit into
base: canary
Choose a base branch
from

Conversation

valguzin55
Copy link

@valguzin55 valguzin55 commented Mar 19, 2024

Closes #

📝 Description

add direct control state navbar-menu open/close for 2 or more navbarmenu in navbar

⛳️ Current behavior (updates)

Please describe the current behavior that you are modifying

🚀 New behavior

Please describe the behavior or changes this PR adds

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

📝 Additional Information

Summary by CodeRabbit

  • New Features
    • Added control over the navbar menu's open state with the new isOpen property.

Copy link

changeset-bot bot commented Mar 19, 2024

⚠️ No Changeset found

Latest commit: 1000630

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

Copy link

vercel bot commented Mar 19, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 19, 2024 7:59am

Copy link

vercel bot commented Mar 19, 2024

@valguzin55 is attempting to deploy a commit to the NextUI Inc Team on Vercel.

A member of the Team first needs to authorize it.

Copy link
Contributor

coderabbitai bot commented Mar 19, 2024

Walkthrough

The update introduces a new isOpen prop to the NavbarMenu component, allowing external control over the menu's visibility. Adjustments have been made to the internal state management to accommodate this new prop. Additionally, there are updates in the destructuring and access patterns of certain properties within the component, enhancing its efficiency and readability.

Changes

File(s) Change Summary
packages/.../navbar-menu.tsx Introduced isOpen prop for external control of menu visibility; updated state logic and property access patterns.

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

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>.
    • Generate unit-tests 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 tests 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 generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yaml

Commits Files that changed from the base of the PR and between e67b3af and 1000630.
Files selected for processing (1)
  • packages/components/navbar/src/navbar-menu.tsx (2 hunks)
Additional comments: 4
packages/components/navbar/src/navbar-menu.tsx (4)
  • 24-27: The introduction of the isOpen prop is a significant enhancement, allowing for direct control over the navbar menu's open/close state. This change aligns with the PR's objective to provide developers with more flexibility in managing menu visibility, especially in scenarios involving multiple NavbarMenu components.
  • 31-49: The logic for determining the isMenuOpen state based on the isOpen prop is correctly implemented. However, it's essential to ensure that this change does not inadvertently affect existing implementations that rely on the internal state management of the NavbarMenu component. Consider adding documentation or migration guidelines if this change could impact existing users.
  • 54-61: The use of useCallback for the MenuWrapper component is appropriate, given that it depends on the isMenuOpen state. This optimization helps avoid unnecessary re-renders of the MenuWrapper component when the isMenuOpen state changes.
  • 21-71: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [68-88]

The handling of the data-open attribute and the conditional rendering based on the isMenuOpen state are well-implemented. These changes ensure that the menu's visibility is correctly managed according to the isOpen prop or the internal state from the NavbarContext. However, it's crucial to test these changes thoroughly, especially in scenarios where the isOpen prop might change frequently or where multiple NavbarMenu components are used within a single navbar.

Copy link
Member

@wingkwong wingkwong left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR. Please provide the following items:

  • changeset
  • a test case for handling this behaviour
  • an example in docs

Also please lint the code. some changes like className={slots.menu?.({ class: styles })} shouldn't be included.

@wingkwong wingkwong changed the base branch from main to canary April 28, 2024 14:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants