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: scroll offset should not block #294

Merged
merged 1 commit into from
Dec 16, 2024
Merged

fix: scroll offset should not block #294

merged 1 commit into from
Dec 16, 2024

Conversation

zombieJ
Copy link
Member

@zombieJ zombieJ commented Dec 16, 2024

当 VirtualList 不是定格时,mouseY 和 getBoundingClientRect 的 top & bottom 是不一致的。需要减去滚动 offset。

PS: jsdom 无法测试这个。

Summary by CodeRabbit

  • 功能更新
    • 修改了页面坐标计算方式,现已考虑当前的滚动偏移量。

Copy link

vercel bot commented Dec 16, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
virtual-list ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 16, 2024 10:56am

Copy link

coderabbitai bot commented Dec 16, 2024

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 eslint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/hooks/useScrollDrag.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

Error: Cannot read config file: /.eslintrc.js
Error: Cannot find module '@umijs/fabric/dist/eslint'
Require stack:

  • /.eslintrc.js
  • /node_modules/.pnpm/@eslint[email protected]/node_modules/@eslint/eslintrc/dist/eslintrc.cjs
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/cli-engine/cli-engine.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/eslint/eslint.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/eslint/index.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/lib/cli.js
  • /node_modules/.pnpm/[email protected]/node_modules/eslint/bin/eslint.js
    at Module._resolveFilename (node:internal/modules/cjs/loader:1248:15)
    at Module._load (node:internal/modules/cjs/loader:1074:27)
    at TracingChannel.traceSync (node:diagnostics_channel:315:14)
    at wrapModuleLoad (node:internal/modules/cjs/loader:217:24)
    at Module.require (node:internal/modules/cjs/loader:1339:12)
    at require (node:internal/modules/helpers:135:16)
    at Object. (/.eslintrc.js:1:14)
    at Module._compile (node:internal/modules/cjs/loader:1546:14)
    at Module._extensions..js (node:internal/modules/cjs/loader:1691:10)
    at Module.load (node:internal/modules/cjs/loader:1317:32)

概述

遍历

src/hooks/useScrollDrag.ts 文件中,getPageXY 函数的实现被修改,现在在计算页面坐标时会减去当前的滚动位置。这一变更确保了在处理鼠标或触摸事件时,能够准确获取相对于可视区域的坐标值,同时保持了原有函数的整体逻辑和签名不变。

变更

文件 变更说明
src/hooks/useScrollDrag.ts 修改 getPageXY 函数,在返回页面坐标时减去滚动偏移量

序列图

sequenceDiagram
    participant User
    participant Event
    participant Function
    participant Window
    
    User->>Event: 触发鼠标/触摸事件
    Event->>Function: 调用 getPageXY
    Function->>Window: 获取滚动位置
    Function-->>Event: 返回调整后的坐标
Loading

可能相关的 PR

  • feat: mouse down to scroll #293:引入 useScrollDrag 钩子,与本 PR 中的 getPageXY 函数变更直接相关,两者都涉及滚动行为和鼠标事件处理。

诗歌

🐰 滚动坐标,兔子轻跳
减去偏移,精准瞄
鼠标轨迹,清晰描绘
代码如风,优雅飘
坐标精准,兔子欢笑 🌈

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request.


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.

CodeRabbit Configuration 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

@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)
src/hooks/useScrollDrag.ts (1)

Line range hint 16-93: 建议补充手动测试用例

由于 PR 描述中提到 jsdom 测试的限制,建议:

  1. 添加手动测试步骤说明
  2. 考虑在不同滚动场景下的测试用例
  3. 特别关注大页面滚动时的边界情况

需要我帮助编写测试用例说明文档吗?

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between aaabcb8 and fc5656d.

📒 Files selected for processing (1)
  • src/hooks/useScrollDrag.ts (1 hunks)
🔇 Additional comments (1)
src/hooks/useScrollDrag.ts (1)

13-13: 修复滚动偏移量计算逻辑正确!

代码变更正确解决了视口坐标与页面坐标之间的不匹配问题。由于 getBoundingClientRect 返回的是相对于视口的坐标,减去滚动偏移量是必要的。

建议验证在不同浏览器中的兼容性:

✅ Verification successful

Based on the search results, I can see that scrollX and scrollY are only used in useScrollDrag.ts and there are no browser compatibility handling code for these properties. However, since these properties are well-supported in modern browsers (IE9+), and the codebase seems to be targeting modern browsers (using React hooks, TypeScript, etc.), I can generate the final response:

滚动偏移量计算方案可靠,无需额外兼容性处理!

window.scrollXwindow.scrollY 在现代浏览器中有良好的支持度,当前实现方案简洁有效。代码中使用 TypeScript、React Hooks 等现代特性,说明已经定位于现代浏览器,无需增加额外的兼容性处理代码。

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 检查是否有针对 scrollX/scrollY 的兼容性处理代码

# 搜索是否存在浏览器兼容性相关代码
rg -i "scroll|pageXOffset|pageYOffset" --type ts

Length of output: 23561

Copy link

codecov bot commented Dec 16, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.32%. Comparing base (aaabcb8) to head (fc5656d).

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #294   +/-   ##
=======================================
  Coverage   98.32%   98.32%           
=======================================
  Files          19       19           
  Lines         778      778           
  Branches      187      187           
=======================================
  Hits          765      765           
  Misses         13       13           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@zombieJ zombieJ merged commit 53cb09c into master Dec 16, 2024
12 checks passed
@zombieJ zombieJ deleted the fix-scroll branch December 16, 2024 11:00
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.

1 participant