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: retire deprecated api #511

Merged
merged 4 commits into from
Feb 18, 2025

Conversation

aojunhao123
Copy link
Contributor

@aojunhao123 aojunhao123 commented Feb 15, 2025

QQ_1739609356275
这一块我理解别的依赖的地方也需要对应做改动

Summary by CodeRabbit

  • 重构
    • 简化了组件的配置接口,移除了多个已弃用的属性,并更新了过渡效果的配置方式,为用户提供更加直观一致的交互体验。
  • 测试
    • 删除了与已弃用属性相关的测试用例,并更新了面具过渡的测试配置,确保测试覆盖与现有组件行为保持同步。

Copy link

coderabbitai bot commented Feb 15, 2025

Walkthrough

这次变更主要移除了 Trigger 组件中已弃用的属性和函数。在 src/index.tsx 中,删除了 TriggerProps 接口中的多个弃用属性,并更新了 generateTrigger 函数以仅依赖当前的属性。与此同时,在 src/util.ts 中移除了 getMotion 函数。测试文件中也同步更新:部分测试用例被删除或修改,以适应接口和功能的简化。

Changes

文件 变更概述
src/index.tsx 删除 TriggerProps 接口中弃用的属性(destroyPopupOnHide、popupTransitionName、popupAnimation、maskTransitionName、maskAnimation、className),更新 generateTrigger 函数逻辑,仅依赖 autoDestroy、popupMotion 和 maskMotion。
src/util.ts 移除 getMotion 函数及其相关逻辑。
tests/basic.test.jsx 删除验证 destroyPopupOnHide 和 className 属性行为的测试用例。
tests/mask.test.jsx 将测试中的 maskTransitionName 配置更新为 maskMotion 对象,配置为 { motionName: 'bamboo' }
tests/util.test.jsx 删除与 getMotion 函数和 MockTrigger 组件相关的全部测试。
docs/examples/body-overflow.tsx 将 popupTransitionName 属性替换为 popupMotion 对象,包含 motionName 属性。
docs/examples/case.tsx 将 destroyPopupOnHide 属性替换为 autoDestroy。
docs/examples/container.tsx 将 popupTransitionName 属性替换为 popupMotion 对象,包含 motionName 属性。
docs/examples/simple.tsx 移除 destroyPopupOnHide 和 maskAnimation 属性,添加 maskMotion 和 popupMotion 属性。

Sequence Diagram(s)

sequenceDiagram
    participant C as 调用者
    participant GT as generateTrigger
    participant P as TriggerProps
    C->>GT: 传入 TriggerProps(包含 autoDestroy, popupMotion, maskMotion)
    GT->>P: 读取 autoDestroy 及运动属性
    GT-->>GT: 根据 autoDestroy 计算 mergedAutoDestroy
    GT->>GT: 直接使用 popupMotion 和 maskMotion 处理运动逻辑
    GT->>C: 返回处理后的 trigger 配置
Loading

Possibly related PRs

Suggested reviewers

  • afc163

Poem

小兔跳跃代码园,
弃用陈迹已随风。
弹窗轻舞逻辑新,
清晰简约展宏图。
萌兔庆改齐欢笑,
代码花开乐无穷!

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.

docs/examples/body-overflow.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-react".

(The package "eslint-plugin-react" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react@latest --save-dev

The plugin "eslint-plugin-react" was referenced from the config file in ".eslintrc.js » /node_modules/.pnpm/@umijs[email protected][email protected]/node_modules/@umijs/fabric/dist/eslint.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

docs/examples/case.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-react".

(The package "eslint-plugin-react" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react@latest --save-dev

The plugin "eslint-plugin-react" was referenced from the config file in ".eslintrc.js » /node_modules/.pnpm/@umijs[email protected][email protected]/node_modules/@umijs/fabric/dist/eslint.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

docs/examples/simple.tsx

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-react".

(The package "eslint-plugin-react" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-react@latest --save-dev

The plugin "eslint-plugin-react" was referenced from the config file in ".eslintrc.js » /node_modules/.pnpm/@umijs[email protected][email protected]/node_modules/@umijs/fabric/dist/eslint.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

  • 1 others

📜 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 4d2010e and 4430f35.

📒 Files selected for processing (4)
  • docs/examples/body-overflow.tsx (4 hunks)
  • docs/examples/case.tsx (1 hunks)
  • docs/examples/container.tsx (1 hunks)
  • docs/examples/simple.tsx (2 hunks)
🔇 Additional comments (4)
docs/examples/case.tsx (1)

205-205: 属性更新正确实现

autoDestroy 属性的使用符合新的 API 规范。

docs/examples/container.tsx (1)

163-165: 更新过渡动画属性的实现符合预期!

将已弃用的 popupTransitionName 属性替换为新的 popupMotion 对象结构,实现正确。

docs/examples/body-overflow.tsx (1)

48-50: 所有触发器组件的动画属性更新保持一致!

在所有 Trigger 组件实例中统一使用新的 popupMotion 对象结构替换已弃用的过渡属性,实现规范统一。

Also applies to: 107-109, 163-165, 212-214

docs/examples/simple.tsx (1)

361-363: 动画属性的完整实现非常出色!

  1. 正确实现了遮罩层动画 maskMotion
  2. 弹出层动画 popupMotion 保持了与状态的动态绑定
  3. 用户界面控制与新实现完美配合

这些更改完全符合移除已弃用 API 的目标。

Also applies to: 376-378


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/index.tsx (1)

48-123: 建议添加迁移指南注释

建议在 TriggerProps 接口上方添加注释,说明已移除的属性以及用户应该使用的新属性,这样可以帮助用户更顺利地进行迁移。

+/**
+ * @deprecated The following properties have been removed:
+ * - destroyPopupOnHide (use autoDestroy instead)
+ * - popupTransitionName (use popupMotion instead)
+ * - maskTransitionName (use maskMotion instead)
+ * - popupAnimation (use popupMotion instead)
+ * - maskAnimation (use maskMotion instead)
+ */
 export interface TriggerProps {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a53c077 and 95b0ef2.

📒 Files selected for processing (5)
  • src/index.tsx (3 hunks)
  • src/util.ts (0 hunks)
  • tests/basic.test.jsx (0 hunks)
  • tests/mask.test.jsx (1 hunks)
  • tests/util.test.jsx (0 hunks)
💤 Files with no reviewable changes (3)
  • src/util.ts
  • tests/util.test.jsx
  • tests/basic.test.jsx
🔇 Additional comments (3)
tests/mask.test.jsx (1)

24-26: 迁移到新的动画 API 实现正确!

成功地将已弃用的 maskTransitionName 属性迁移到新的 maskMotion 对象结构。这种改变与组件 API 的现代化方向保持一致。

src/index.tsx (2)

191-191: 简化 autoDestroy 逻辑正确!

成功移除了对已弃用的 destroyPopupOnHide 属性的依赖,使用 autoDestroy 作为唯一的控制选项使代码更加清晰。


683-684: 动画属性传递更新正确!

成功地将 motion 相关属性直接传递给 Popup 组件,移除了对已弃用属性的支持,使代码更加简洁。

Copy link

codecov bot commented Feb 18, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 97.71%. Comparing base (a9c5ec8) to head (4430f35).
Report is 2 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #511      +/-   ##
==========================================
- Coverage   97.75%   97.71%   -0.04%     
==========================================
  Files          13       13              
  Lines         800      788      -12     
  Branches      235      235              
==========================================
- Hits          782      770      -12     
  Misses         18       18              

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

@zombieJ zombieJ merged commit e5a6910 into react-component:master Feb 18, 2025
9 checks passed
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.

2 participants