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(dropdown): correct initial animation direction to match fallback placement #4288

Merged
merged 3 commits into from
Dec 10, 2024

Conversation

ryo-manba
Copy link
Member

@ryo-manba ryo-manba commented Dec 9, 2024

Closes #4251

📝 Description

When the fallback placement is used, the animation did not follow the final placement.
As a result, the popup position and its animation did not match.

⛳️ Current behavior (updates)

The popup shows in the correct place, but the initial animation starts from the wrong direction, causing a flicker.

dropdown-animation-before.mov

🚀 New behavior

The animation now correctly aligns with the final placement.
Changed the code to use useOverlayPosition similar to the Tooltip implementation.

dropdown-animation-after.mov

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

No.

📝 Additional Information

Dropdown docs do not mention placement, but that will be addressed separately.

Summary by CodeRabbit

  • New Features

    • Added a new dependency for enhanced dropdown functionality.
    • Introduced new props for flexible dropdown positioning, including containerPadding, offset, crossOffset, and shouldFlip.
    • New Storybook story demonstrating various dropdown placements.
  • Bug Fixes

    • Improved management of dropdown placement defaults and configurations.
  • Documentation

    • Enhanced Storybook examples with a new story and updated template for better clarity.

Copy link

vercel bot commented Dec 9, 2024

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 Dec 9, 2024 8:52am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 9, 2024 8:52am

Copy link

changeset-bot bot commented Dec 9, 2024

🦋 Changeset detected

Latest commit: bf3790c

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/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 Dec 9, 2024

Warning

Rate limit exceeded

@ryo-manba has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 15 minutes and 33 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 de11cf8 and bf3790c.

📒 Files selected for processing (1)
  • packages/components/dropdown/stories/dropdown.stories.tsx (2 hunks)

Walkthrough

The pull request introduces several changes to the dropdown component. A new dependency, @react-aria/overlays version 3.24.0, is added to the package.json. The use-dropdown.ts file is modified to enhance the useDropdown hook, introducing new props for flexible positioning and updating the placement management. Additionally, a new story, WithFallbackPlacements, is added to the Storybook configuration to demonstrate various dropdown placements, along with updates to the Template function for improved labeling.

Changes

File Change Summary
packages/components/dropdown/package.json Added dependency: "@react-aria/overlays": "3.24.0"
packages/components/dropdown/src/use-dropdown.ts - Added toReactAriaPlacement function and DEFAULT_PLACEMENT constant.
- Updated useDropdown parameters to include placementProp, containerPadding, offset, crossOffset, and shouldFlip.
- Modified getPopoverProps to derive placement from useOverlayPosition.
packages/components/dropdown/stories/dropdown.stories.tsx - Added new story: WithFallbackPlacements for demonstrating various dropdown placements.
- Updated Template function to include a new label prop.

Assessment against linked issues

Objective Addressed Explanation
Dropdown menu should always animate in the correct direction it is appearing in (#[4251])

Possibly related PRs

Suggested labels

📋 Scope : Docs

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
🪧 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: 2

🧹 Outside diff range and nitpick comments (1)
packages/components/dropdown/src/use-dropdown.ts (1)

167-167: Simplify placement assignment in getPopoverProps

In getPopoverProps, the placement is assigned using placement: placement || DEFAULT_PLACEMENT. Since placement already defaults to DEFAULT_PLACEMENT, this may be redundant. Consider simplifying the assignment.

Apply this diff to streamline the code:

 return {
   state,
-  placement: placement || DEFAULT_PLACEMENT,
+  placement,
   ref: popoverRef,
   disableAnimation,
   // ...
 }
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 3b390fb and b025629.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (3)
  • packages/components/dropdown/package.json (1 hunks)
  • packages/components/dropdown/src/use-dropdown.ts (5 hunks)
  • packages/components/dropdown/stories/dropdown.stories.tsx (2 hunks)
🔇 Additional comments (3)
packages/components/dropdown/src/use-dropdown.ts (1)

142-151: Ensure correct handling of overlay positioning props

The useOverlayPosition hook utilizes the new positioning props (offset, crossOffset, shouldFlip, containerPadding). Verify that these props are correctly passed down and that their default values align with the expected behavior.

packages/components/dropdown/package.json (1)

51-51: Verify the new dependency version and check for security advisories

The dependency @react-aria/overlays version "3.24.0" has been added. Ensure that this version is compatible with other dependencies and is free from known vulnerabilities.

Run the following script to check for the latest version and any security advisories:

✅ Verification successful

Dependency version is up-to-date and secure

The version 3.24.0 of @react-aria/overlays is currently the latest version available on npm, and there are no known security vulnerabilities reported for this package.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Check the latest version and security advisories for @react-aria/overlays

# Get the latest version from npm
npm view @react-aria/overlays version

# Check for known vulnerabilities using GitHub's security advisories
gh api graphql -f query='
{
  securityVulnerabilities(first: 5, ecosystem: NPM, package: "@react-aria/overlays") {
    nodes {
      advisory {
        summary
        severity
        publishedAt
      }
      vulnerableVersionRange
      firstPatchedVersion {
        identifier
      }
    }
  }
}'

Length of output: 400

packages/components/dropdown/stories/dropdown.stories.tsx (1)

143-143: Verify default value impact for the new 'label' prop

The label prop has been added to the Template function with a default value of "Trigger". Ensure that this change does not adversely affect existing stories that may rely on the previous hardcoded label.

@ryo-manba ryo-manba changed the title fix(dropdown): correct initial animation direction fix(dropdown): correct initial animation direction to match fallback placement Dec 9, 2024
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] - DropdownMenu animates in wrong direction on first open (auto placement)
3 participants