refactor(popover): use `usePreventScroll` instead of `react-remove-scroll`
Closes #3474
📝 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
- Popover and Tooltip components now include enhanced scroll prevention functionality when open, improving user experience.
-
Bug Fixes
- Resolved issues related to scroll blocking and animation handling in the Popover component.
-
Dependencies
- Updated various dependencies for compatibility and performance improvements, including
@nextui-org/system,@nextui-org/theme, andframer-motion.
- Updated various dependencies for compatibility and performance improvements, including
-
Refactor
- Reorganized dependency lists and streamlined internal logic for better maintainability.
🦋 Changeset detected
Latest commit: c57e9eb2a923ab5f0e00d227294628d37dc8251f
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
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 |
@chirokas is attempting to deploy a commit to the NextUI Inc Team on Vercel.
A member of the Team first needs to authorize it.
Walkthrough
This update enhances the scroll management capabilities in the Popover and Tooltip components. Key changes include the introduction of the usePreventScroll hook, which effectively manages scroll blocking while these components are active. The shouldBlockScroll prop in the Tooltip has been rectified to function correctly. Additionally, various dependencies in package.json have been reorganized for clarity.
Changes
| File Path | Change Summary |
|---|---|
packages/components/popover/package.json |
Updated and reordered dependencies; added new dependencies like @nextui-org/use-aria-button and @nextui-org/shared-utils. |
packages/components/popover/src/popover-content.tsx |
Removed RemoveScroll and simplified scroll blocking logic. |
packages/components/popover/src/use-popover.ts |
Introduced usePreventScroll hook and removed shouldBlockScroll from the returned object. |
packages/components/tooltip/src/use-tooltip.ts |
Implemented usePreventScroll and added shouldBlockScroll prop in the Props interface, handling it within useTooltip. |
Assessment against linked issues
| Objective (Issue #) | Addressed | Explanation |
|---|---|---|
Fix shouldBlockScroll prop in Tooltip component (#3474) |
✅ |
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?
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
@coderabbitaiin 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
@coderabbitaiin 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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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.