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

Merged
merged 3 commits into from
Dec 30, 2024

Conversation

ryo-manba
Copy link
Member

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

Closes #4290

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

popover-animation-before.mov

🚀 New behavior

The animation now correctly aligns with the final placement.

popover-animation-after.mov

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

No.

📝 Additional Information

Related PR: #4288

Summary by CodeRabbit

  • New Features

    • Added a default placement of "top" for popovers
    • Introduced a new story showcasing popover placement options
  • Improvements

    • Simplified popover placement logic
    • Enhanced popover story with customizable labels

Copy link

vercel bot commented Dec 30, 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 30, 2024 6:35am
nextui-storybook-v2 ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 30, 2024 6:35am

Copy link

changeset-bot bot commented Dec 30, 2024

🦋 Changeset detected

Latest commit: e0962a8

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

This PR includes changesets to release 6 packages
Name Type
@nextui-org/popover Patch
@nextui-org/autocomplete Patch
@nextui-org/date-picker Patch
@nextui-org/dropdown Patch
@nextui-org/select 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 30, 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 10 minutes and 11 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 bbdd9d7 and e0962a8.

📒 Files selected for processing (1)
  • .changeset/witty-goats-trade.md (1 hunks)

Walkthrough

The pull request introduces changes to the Popover component's placement handling in two files: use-popover.ts and popover.stories.tsx. The modifications focus on simplifying the placement logic by introducing a default placement constant of "top" and updating the usePopover function to use this default. A new story is added to popover.stories.tsx to demonstrate various placement options, enhancing the component's documentation and testing capabilities.

Changes

File Change Summary
packages/components/popover/src/use-popover.ts - Added DEFAULT_PLACEMENT constant with value "top"
- Updated usePopover function to use DEFAULT_PLACEMENT
- Simplified placement logic and import statements
packages/components/popover/stories/popover.stories.tsx - Added new WithFallbackPlacements story
- Modified Template function to accept custom label
- Demonstrated multiple popover placements

Assessment against linked issues

Objective Addressed Explanation
Fix popover animation direction on first open [#4290]

Possibly related PRs

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

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: 0

🧹 Nitpick comments (1)
packages/components/popover/src/use-popover.ts (1)

226-226: Complete dependency array for the callback.

Listing all relevant dependencies (slots, state.isOpen, placement, etc.) ensures the popover content is recalculated correctly when any input changes.

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4f0ef58 and bbdd9d7.

📒 Files selected for processing (2)
  • packages/components/popover/src/use-popover.ts (7 hunks)
  • packages/components/popover/stories/popover.stories.tsx (2 hunks)
🔇 Additional comments (8)
packages/components/popover/src/use-popover.ts (6)

17-17: Import usage is consistent with the code updates.

The getArrowPlacement import is now used to dynamically compute the arrow position, which aligns well with the revised placement logic.


84-85: Good introduction of a named default placement constant.

Defining DEFAULT_PLACEMENT as "top" is clear and reduces magic strings, making the code more maintainable. This also helps ensure consistency across the component.


115-115: Maintains consistency for default placement.

Referencing DEFAULT_PLACEMENT here improves clarity and ensures a single source of truth for the default placement value.


209-209: Appropriate usage of getArrowPlacement.

Passing both the resolved placement and placementProp ensures the arrow is positioned correctly, even if a fallback placement is used.


223-223: Consistent approach to arrow placement.

Using the same getArrowPlacement logic here confirms that arrow rendering remains predictable and in sync with the component’s final placement.


310-310: Ensures a valid placement in all scenarios.

Falling back to DEFAULT_PLACEMENT here further guarantees that the popover is always placed consistently and avoids potential undefined placement errors.

packages/components/popover/stories/popover.stories.tsx (2)

130-134: Flexible labeling for the popover trigger button.

By adding a label prop to the Template, you effectively allow story authors to reuse the same template with different button labels without duplicating code.


584-609: Comprehensive fallback placement demo.

The WithFallbackPlacements story thoroughly illustrates how different placements behave under real-world positioning scenarios. This should help confirm the new popover logic aligns with user expectations, especially regarding fallback placement animation.

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] - Popover animate in the wrong direction on first open (auto placement)
3 participants