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

fix(navbar): lazy motion forwardRef issue #2527

Merged
merged 1 commit into from
Mar 15, 2024

Conversation

wingkwong
Copy link
Member

@wingkwong wingkwong commented Mar 15, 2024

Closes #2521

📝 Description

swapped the level of LazyMotion and MenuWrapper

⛳️ Current behavior (updates)

currently we can't scroll mobile sidebar due to the latest lazy motion changes

🚀 New behavior

pr-2527-demo.webm

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

No

📝 Additional Information

Summary by CodeRabbit

  • Bug Fixes
    • Fixed an issue in the navigation bar related to the LazyMotion ForwardRef, improving stability and potentially animation behavior.

@wingkwong wingkwong requested a review from jrgarciadev as a code owner March 15, 2024 04:09
Copy link

changeset-bot bot commented Mar 15, 2024

🦋 Changeset detected

Latest commit: 5253e39

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

Copy link

vercel bot commented Mar 15, 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 15, 2024 4:12am

Copy link
Contributor

coderabbitai bot commented Mar 15, 2024

Walkthrough

The patch addresses a specific issue with the @nextui-org/navbar component, particularly focusing on a bug that prevented the sidebar in NextUI docs from being scrollable on mobile devices. The changes involve a strategic rearrangement of the LazyMotion and MenuWrapper components within NavbarMenu, and a direct modification aimed at enabling sidebar scrollability on mobile by altering the MenuWrapper component's behavior.

Changes

File Path Change Summary
.changeset/dirty-beans-repair.md Introduces a patch for LazyMotion ForwardRef issue.
.../navbar/src/navbar-menu.tsx Reorders LazyMotion and MenuWrapper; alters MenuWrapper for mobile scrollability.

Assessment against linked issues

Objective Addressed Explanation
Bug Description and Expected Behavior (#2521)
Reproduction Steps (#2521) The provided summary does not detail if the specific reproduction steps were considered in testing the fix.
Code Fix - Removing RemoveScroll to enable sidebar scrolling (#2521)
Visual Aid - Reference to the issue's screenshot (#2521) The summary does not mention any visual validation or adjustments based on the provided screenshot.

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

vercel bot commented Mar 15, 2024

@wingkwong 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 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 5a8768a and 5253e39.
Files selected for processing (2)
  • .changeset/dirty-beans-repair.md (1 hunks)
  • packages/components/navbar/src/navbar-menu.tsx (2 hunks)
Additional comments: 2
.changeset/dirty-beans-repair.md (1)
  • 1-5: The changeset file accurately documents the patch for the "@nextui-org/navbar" package, addressing the LazyMotion ForwardRef issue. This documentation is crucial for tracking changes and understanding the scope of the patch.
packages/components/navbar/src/navbar-menu.tsx (1)
  • 60-67: > 📝 NOTE

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

The reordering of the LazyMotion and MenuWrapper components within the NavbarMenu component is well-integrated and aligns with the PR objectives to fix the scrolling issue on mobile devices. Ensure thorough testing is conducted to verify that this change does not negatively impact the animation behavior or introduce any new issues.

Copy link
Member

@jrgarciadev jrgarciadev left a comment

Choose a reason for hiding this comment

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

Thank you! @wingkwong

@jrgarciadev jrgarciadev merged commit 707a61d into heroui-inc:main Mar 15, 2024
7 of 8 checks passed
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.

[BUG] - NextUI docs sidebar doesn't scroll on mobile
2 participants