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

feat: retire deprecated api #491

Merged
merged 1 commit into from
Jan 10, 2025
Merged

Conversation

aojunhao123
Copy link
Contributor

@aojunhao123 aojunhao123 commented Jan 9, 2025

Summary by CodeRabbit

  • 新功能

    • 更新了 Tooltip 组件的动画处理方式
    • 从使用 animationtransitionName 属性改为使用更灵活的 motion 属性
  • 重构

    • 移除了已弃用的 animationtransitionName 属性
    • 简化了 Tooltip 组件的属性接口
  • 文档

    • 更新了示例代码以展示新的动画配置方法

Copy link

vercel bot commented Jan 9, 2025

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

Name Status Preview Comments Updated (UTC)
tooltip ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 9, 2025 11:57am

Copy link

coderabbitai bot commented Jan 9, 2025

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/formError.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: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)

概述

演练

这个拉取请求主要修改了 Tooltip 组件的动画属性处理方式。从原来的 animationtransitionName 属性转变为使用更加灵活的 motion 属性。这一变更涉及多个文件,包括文档示例和组件源代码,目的是统一和简化动画配置的方式。

变更

文件 变更摘要
docs/examples/formError.tsx animation 替换为 motion 属性
docs/examples/onVisibleChange.tsx 更新 Tooltip 组件的动画配置
docs/examples/simple.tsx 修改 transitionNamemotion 对象
src/Tooltip.tsx 移除 animationtransitionName 属性,简化接口

可能相关的 PR

建议的审阅者

  • zombieJ

诗歌

🐰 动画属性,悄然变迁
从字符串到对象,新的篇章
motion 闪耀,代码轻舞
简洁优雅,兔子欢颜
重构之路,技术飞翔!

Finishing Touches

  • 📝 Generate Docstrings

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

codecov bot commented Jan 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (ac46af1) to head (30b63ed).
Report is 1 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff            @@
##            master      #491   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines           33        33           
  Branches        12        12           
=========================================
  Hits            33        33           

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

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)
docs/examples/simple.tsx (1)

219-219: 建议更新状态属性名称以保持一致性

虽然已正确将 transitionName 属性替换为 motion 属性,但状态中仍使用 transitionName 作为属性名可能会造成混淆。

建议将状态属性名也更新为 motionName

- transitionName: string;
+ motionName: string;

- transitionName: 'rc-tooltip-zoom',
+ motionName: 'rc-tooltip-zoom',

- checked={this.state.transitionName === 'rc-tooltip-zoom'}
+ checked={this.state.motionName === 'rc-tooltip-zoom'}

- motion={{ motionName: this.state.transitionName }}
+ motion={{ motionName: this.state.motionName }}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between ac46af1 and 30b63ed.

📒 Files selected for processing (4)
  • docs/examples/formError.tsx (1 hunks)
  • docs/examples/onVisibleChange.tsx (2 hunks)
  • docs/examples/simple.tsx (1 hunks)
  • src/Tooltip.tsx (1 hunks)
🔇 Additional comments (4)
src/Tooltip.tsx (2)

3-3: 导入语句更新以移除已弃用的类型

已移除 AnimationType 导入,这与移除已弃用的 animation 属性保持一致。


Line range hint 1-150: 验证是否完全移除了已弃用的属性

让我们验证代码库中是否还有任何对已弃用属性的引用。

✅ Verification successful

已确认弃用属性的处理方式符合规范

  • 已弃用的属性(overlayStyle、overlayClassName、overlayInnerStyle)都已通过 @deprecated 标记
  • 新的替代属性(styles.root、classNames.root、styles.body)已经实现
  • transitionName 的使用仅存在于文档示例中
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# 描述:检查是否还有任何对已弃用属性的引用

# 搜索 animation 属性的使用
echo "检查 animation 属性的使用:"
rg "animation['\"]?\s*[=:]" 

# 搜索 transitionName 属性的使用
echo "检查 transitionName 属性的使用:"
rg "transitionName['\"]?\s*[=:]"

Length of output: 475

docs/examples/formError.tsx (1)

37-37: 示例更新使用新的动画 API

已正确将 animation 属性替换为新的 motion 属性。

docs/examples/onVisibleChange.tsx (1)

40-40: 示例保持一致地更新了动画 API

已正确将 animation 属性替换为新的 motion 属性,与其他示例保持一致。

@zombieJ zombieJ merged commit e8e35fc into react-component:master Jan 10, 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