fix: remove drawer mask not lock scroll #472

andybuibui · 2024-06-19T03:06:23Z

refer:

Summary by CodeRabbit

Bug Fixes
- 修复了抽屉组件锁定滚动行为，使其不再依赖于遮罩（mask）属性，提升了使用一致性。
Tests
- 更新并新增了相关测试用例，确保在不同容器下滚动锁定逻辑的正确性。

vercel · 2024-06-19T03:06:27Z

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

Name	Status	Preview	Comments	Updated (UTC)
drawer	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 30, 2025 8:20am

yoyo837 · 2024-06-19T03:08:08Z

Test case please.

yoyo837 · 2024-06-19T03:43:23Z

看上去是对 #350 的逆向。

crazyair · 2024-06-19T04:27:16Z

我觉得不应该逆向改回去，可以在目前的基础上优化，不如 Drawer 的坐标 right 可以根据滚动条锁定动态变化

andybuibui · 2024-06-19T05:40:29Z

看上去是对 #350 的逆向。

是的，逆向的。同理如果modal 设置mask = false 情况下， body是否需要滚动？我觉得根据container来判断似乎更加合理。
或者自己传递参数控制？

coderabbitai · 2025-05-30T08:18:51Z

Walkthrough

本次更改将 Drawer 组件中 Portal 的 autoLock 行为从依赖 mask 属性修改为仅依赖 mergedOpen 或 animatedVisible。无论 mask 是否为 false，只要 Drawer 处于打开或动画可见状态，autoLock 都为 true。同时，测试用例也同步调整，验证 body 滚动锁定逻辑。

Changes

文件/分组	变更摘要
src/Drawer.tsx	修改 autoLock 判断逻辑，使其与 mask 属性无关
tests/index.spec.tsx	替换和新增测试用例，验证 getContainer 不同返回值下 body 滚动锁定

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Drawer
    participant Portal
    participant DocumentBody

    User->>Drawer: 打开 Drawer
    Drawer->>Portal: 设置 autoLock = mergedOpen || animatedVisible
    alt autoLock 为 true
        Portal->>DocumentBody: 设置 overflowY: hidden
    else autoLock 为 false
        Portal->>DocumentBody: 恢复 overflowY
    end

Assessment against linked issues

Objective	Addressed	Explanation
修复 Drawer 设置 mask=false 时，内部 Modal 打开导致 Drawer 位置闪动 (#49462)	✅

Assessment against linked issues: Out-of-scope changes

（未发现超出关联 issue 目标的变更）

Poem

小兔挥爪改 Drawer，
mask 不锁也能锁，
body 滚动不再乱，
浮窗闪动成传说。
测试同步来守护，
代码清晰如新梭！
🐇✨

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.

tests/index.spec.tsx

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:1405:15)
at require.resolve (node:internal/modules/helpers:145:19)
at Object. (/.eslintrc.js:2:21)
at Module._compile (node:internal/modules/cjs/loader:1734:14)
at Object..js (node:internal/modules/cjs/loader:1899:10)
at Module.load (node:internal/modules/cjs/loader:1469:32)
at Module._load (node:internal/modules/cjs/loader:1286:12)
at TracingChannel.traceSync (node:diagnostics_channel:322:14)
at wrapModuleLoad (node:internal/modules/cjs/loader:235:24)
at Module.require (node:internal/modules/cjs/loader:1491:12)

src/Drawer.tsx

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:1405:15)
at require.resolve (node:internal/modules/helpers:145:19)
at Object. (/.eslintrc.js:2:21)
at Module._compile (node:internal/modules/cjs/loader:1734:14)
at Object..js (node:internal/modules/cjs/loader:1899:10)
at Module.load (node:internal/modules/cjs/loader:1469:32)
at Module._load (node:internal/modules/cjs/loader:1286:12)
at TracingChannel.traceSync (node:diagnostics_channel:322:14)
at wrapModuleLoad (node:internal/modules/cjs/loader:235:24)
at Module.require (node:internal/modules/cjs/loader:1491:12)

📜 Recent review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 2418e05 and e4a246c.

📒 Files selected for processing (2)

src/Drawer.tsx (1 hunks)
tests/index.spec.tsx (2 hunks)

🔇 Additional comments (2)

src/Drawer.tsx (1)

136-136: 变更符合预期目标

移除 mask 条件使得滚动锁定行为与遮罩存在与否解耦，这正确实现了 PR 目标。现在无论 mask 属性如何设置，只要抽屉处于打开或动画状态就会锁定滚动。

tests/index.spec.tsx (1)

146-157: 测试逻辑正确验证新行为

此测试正确验证了当 getContainer 返回非 body 元素时，文档 body 的滚动不会被锁定。这与 src/Drawer.tsx 中修改后的 autoLock 逻辑保持一致。

✨ Finishing Touches

📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
- Explain this complex logic.
- 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 explain this code block.
- @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 explain its main purpose.
- @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

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.

tests/index.spec.tsx

codecov · 2025-05-30T08:28:27Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (2418e05) to head (e4a246c).

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #472   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            5         5           
  Lines          144       144           
  Branches        53        53           
=========================================
  Hits           144       144

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

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

fix: remove drawer mask not lock scroll

391437f

vercel bot deployed to Preview June 19, 2024 03:07 View deployment

fix: add test

0041410

vercel bot deployed to Preview June 19, 2024 03:31 View deployment

Merge branch 'master' into andybuibui-patch-1

7ccefc9

afc163 reviewed May 30, 2025

View reviewed changes

tests/index.spec.tsx Show resolved Hide resolved

Update tests/index.spec.tsx

e4a246c

vercel bot deployed to Preview May 30, 2025 08:20 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix: remove drawer mask not lock scroll #472

fix: remove drawer mask not lock scroll #472

Uh oh!

andybuibui commented Jun 19, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jun 19, 2024 •

edited

Loading

Uh oh!

yoyo837 commented Jun 19, 2024

Uh oh!

yoyo837 commented Jun 19, 2024

Uh oh!

crazyair commented Jun 19, 2024

Uh oh!

andybuibui commented Jun 19, 2024 •

edited

Loading

Uh oh!

coderabbitai bot commented May 30, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Uh oh!

codecov bot commented May 30, 2025

Uh oh!

Uh oh!

Uh oh!

fix: remove drawer mask not lock scroll #472

Are you sure you want to change the base?

fix: remove drawer mask not lock scroll #472

Uh oh!

Conversation

andybuibui commented Jun 19, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Jun 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

yoyo837 commented Jun 19, 2024

Uh oh!

yoyo837 commented Jun 19, 2024

Uh oh!

crazyair commented Jun 19, 2024

Uh oh!

andybuibui commented Jun 19, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented May 30, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Assessment against linked issues: Out-of-scope changes

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Uh oh!

codecov bot commented May 30, 2025

Codecov Report

Uh oh!

Uh oh!

andybuibui commented Jun 19, 2024 •

edited by coderabbitai bot

Loading

vercel bot commented Jun 19, 2024 •

edited

Loading

andybuibui commented Jun 19, 2024 •

edited

Loading

coderabbitai bot commented May 30, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)