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

refactor(menu): Use useMenu and useMenuItem from RA #3261

Merged
merged 6 commits into from
Nov 4, 2024

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Jun 16, 2024

Closes #

📝 Description

Add a brief description

⛳️ 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

  • Refactor

    • Updated dependency management to use useMenu and useMenuItem from @react-aria/menu.
    • Improved handling for hover events within the menu components.
  • Bug Fixes

    • Enhanced logic for hover state management to improve user experience.

@wingkwong wingkwong added this to the v2.5.0 milestone Jun 16, 2024
Copy link

linear bot commented Jun 16, 2024

Copy link

vercel bot commented Jun 16, 2024

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

Name Status Preview Comments Updated (UTC)
nextui-docs-v2 ❌ Failed (Inspect) Nov 4, 2024 9:24pm
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 4, 2024 9:24pm

Copy link

changeset-bot bot commented Jun 16, 2024

🦋 Changeset detected

Latest commit: 15fc777

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

This PR includes changesets to release 3 packages
Name Type
@nextui-org/menu Patch
@nextui-org/dropdown 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

Copy link
Contributor

coderabbitai bot commented Jun 16, 2024

Warning

Rate limit exceeded

@jrgarciadev has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 0 minutes and 50 seconds before requesting another review.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

📥 Commits

Reviewing files that changed from the base of the PR and between c59bcda and 15fc777.

Walkthrough

The recent changes focus on updating the dependency management for the @nextui-org/menu package by leveraging useMenu and useMenuItem from @react-aria instead of custom hooks. This involves refactoring internal functions to enhance code simplicity, consistency, and maintainability. Noteworthy updates include handling hover events more effectively and exposing additional properties related to the hover state.

Changes

File Change Summary
.../menu/src/use-menu-item.ts Refactored to use useMenuItem from @react-aria/menu instead of useAriaMenuItem. Introduced hover event handling and revised variable names for consistency.
.../menu/src/use-menu.ts Renamed the import of useAriaMenu to useMenu from @react-aria/menu.

Sequence Diagram(s)

sequenceDiagram
    participant MenuComponent as Menu Component
    participant MenuItem as Menu Item
    participant AriaMenu as useMenu (@react-aria/menu)
    participant AriaMenuItem as useMenuItem (@react-aria/menu)
    participant HoverHandler as useHover (@react-aria/interactions)

    MenuComponent ->> AriaMenu: Initialize Menu
    MenuItem ->> AriaMenuItem: Initialize Menu Item
    MenuItem ->> HoverHandler: Setup Hover Handling
    HoverHandler ->> MenuItem: Provide Hover Props
    MenuItem ->> MenuComponent: Update on Hover State Change
Loading

The sequence diagram demonstrates the interactions between the main components and hooks involved in the updated logic, capturing initialization and handling of menu and hover events.


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

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.

Actionable comments posted: 1

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 1e3e970 and c59bcda.

Files selected for processing (3)
  • .changeset/sour-seas-buy.md (1 hunks)
  • packages/components/menu/src/use-menu-item.ts (7 hunks)
  • packages/components/menu/src/use-menu.ts (1 hunks)
Files skipped from review due to trivial changes (2)
  • .changeset/sour-seas-buy.md
  • packages/components/menu/src/use-menu.ts
Additional comments not posted (5)
packages/components/menu/src/use-menu-item.ts (5)

15-16: Refactor imports to utilize @react-aria hooks.

The updated imports from @react-aria/menu and @react-aria/interactions align with the PR's objective to standardize hook usage. This should enhance maintainability and ensure compatibility with the wider React ecosystem.


53-55: Refactor function signature to handle hover events.

Incorporating hover-related props directly into the useMenuItem function's signature is a good practice as it explicitly declares the dependencies and interactions this function will handle. This change improves the readability and maintainability of the code.


73-73: Ensure handling of disabled state is consistent.

The logic to determine isDisabledProp by checking both the state.disabledKeys and the originalProps.isDisabled provides a comprehensive approach to setting the disabled state, ensuring that all conditions are accounted for.


Line range hint 86-95: Integration of useAriaMenuItem with expanded props.

The integration of useAriaMenuItem using a detailed configuration object that includes both new and existing props ensures that the component's behavior is both predictable and consistent with the expected functionality of a menu item.


151-151: Ensure hoverProps are merged correctly.

Properly merging hoverProps into getItemProps function ensures that hover interactions are handled correctly at the DOM level, which is crucial for user experience in interactive components like menus.

packages/components/menu/src/use-menu-item.ts Show resolved Hide resolved
@wingkwong wingkwong modified the milestones: v2.5.0, v2.4.3 Jun 22, 2024
@wingkwong wingkwong modified the milestones: v2.4.3, v2.5.0 Jun 22, 2024
@jrgarciadev jrgarciadev merged commit 2aebfcc into canary Nov 4, 2024
6 of 8 checks passed
@jrgarciadev jrgarciadev deleted the refactor/eng-1015 branch November 4, 2024 21:09
ryo-manba pushed a commit that referenced this pull request Nov 6, 2024
* refactor(menu): use useMenu from react-aria instead

* refactor(menu): use useMenuItem from react-aria instead

* feat(changeset): add changeset

* chore: merged with canary

* fix: dropdown tests

---------

Co-authored-by: Junior Garcia <jrgarciadev@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants