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(popover): use usePreventScroll instead of react-remove-scroll #3307

Open
wants to merge 2 commits into
base: canary
Choose a base branch
from

Conversation

chirokas
Copy link
Contributor

@chirokas chirokas commented Jun 23, 2024

Closes #

📝 Description

This PR improves the shouldBlockScroll behavior by using usePreventScroll instead of react-remove-scroll to be consistent with the Modal.

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

    • Enhanced popover functionality with improved scroll prevention using the usePreventScroll hook.
  • Deprecations

    • Removed support for react-remove-scroll.
  • Dependency Updates

    • Updated peer dependencies including framer-motion to version 11.0.22.
  • Component Enhancements

    • Simplified logic in PopoverContent component for better performance and maintainability.

Copy link

changeset-bot bot commented Jun 23, 2024

🦋 Changeset detected

Latest commit: 690f200

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

vercel bot commented Jun 23, 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 Jun 23, 2024 1:14pm

Copy link

vercel bot commented Jun 23, 2024

@chirokas 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 Jun 23, 2024

Walkthrough

The updates implement a patch for the @nextui-org/popover package, transitioning from react-remove-scroll to the usePreventScroll hook for improved scroll management. Dependencies and peer dependencies are reordered and updated in package.json, along with various adjustments to PopoverContent and usePopover files to remove the old scroll blocking logic. Additionally, a new shouldBlockScroll property is introduced in the storybook configuration.

Changes

Files/Paths Change Summaries
.changeset/real-cows-lie.md Introduces a patch for @nextui-org/popover, replacing react-remove-scroll with usePreventScroll.
packages/components/popover/package.json Reorders and updates peer dependencies, dependencies, and devDependencies.
packages/components/.../popover-content.tsx Removes RemoveScroll import and related logic for scroll blocking and animation handling.
packages/components/.../use-popover.ts Includes usePreventScroll hook in usePopover and removes shouldBlockScroll from the return object.
packages/components/.../popover.stories.tsx Adds a new shouldBlockScroll property with a boolean type control.

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

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.
  • Please see the configuration documentation for more information.
  • 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/schema.v2.json

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

Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 4218335 and 690f200.

Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
Files selected for processing (5)
  • .changeset/real-cows-lie.md (1 hunks)
  • packages/components/popover/package.json (2 hunks)
  • packages/components/popover/src/popover-content.tsx (3 hunks)
  • packages/components/popover/src/use-popover.ts (3 hunks)
  • packages/components/popover/stories/popover.stories.tsx (1 hunks)
Files skipped from review due to trivial changes (2)
  • .changeset/real-cows-lie.md
  • packages/components/popover/stories/popover.stories.tsx
Additional comments not posted (4)
packages/components/popover/package.json (2)

39-39: Update framer-motion version in peerDependencies

The update of framer-motion from 10.17.0 to 11.0.22 in peerDependencies ensures compatibility with newer versions of this dependency, which could include bug fixes and performance improvements.


66-66: Ensure compatibility with updated framer-motion version

The update of framer-motion to ^11.0.22 in devDependencies should be tested to ensure that there are no breaking changes affecting the component's animations or behaviors.

packages/components/popover/src/popover-content.tsx (1)

82-98: Refactor animation logic for popover content

The refactor introduces a conditional rendering based on disableAnimation to either render the content directly or within a LazyMotion component for animations. This change enhances the component's flexibility by allowing animations to be toggled, which can be useful for performance optimizations or specific UI requirements.

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

308-310: Implement scroll prevention logic

The addition of the usePreventScroll hook with a condition based on shouldBlockScroll and the popover's open state is a good use of conditional logic to enhance UX by preventing unwanted scroll when the popover is active.

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.

please fill in the PR description, current behavior, new behavior etc and link issue if applicable.

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.

None yet

2 participants