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 #768

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

aojunhao123
Copy link
Contributor

@aojunhao123 aojunhao123 commented Jan 17, 2025

Summary by CodeRabbit

  • 文档更新

    • 删除了与 renderTabBar 相关的文档和示例文件
  • 接口变更

    • 移除了 TabsProps 中的 onNextClickonPrevClickkeyboard 属性
    • TabsProps 中新增 type 属性
    • 删除了 RenderTabBarProps 接口中的 panes 属性
  • 测试调整

    • 移除了 renderTabBar 相关的测试用例
  • 重构

    • 简化了 TabNavListWrapper 组件的渲染逻辑
    • 移除了与 panes 相关的代码支持

Copy link

vercel bot commented Jan 17, 2025

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

Name Status Preview Comments Updated (UTC)
tabs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jan 17, 2025 2:18pm

Copy link

coderabbitai bot commented Jan 17, 2025

概述

步骤说明

本次变更主要涉及标签页(Tabs)组件的重构,移除了与renderTabBar相关的一些旧实现和文档。变更包括删除文档和示例文件、简化TabNavListWrapper组件、修改Tabs接口,并移除与panes属性相关的测试用例。

变更

文件 变更概要
docs/demo/renderTabBar-use-panes.md 完全删除
docs/examples/renderTabBar-use-panes.tsx 删除示例组件
src/TabNavList/Wrapper.tsx 简化renderTabBar处理逻辑
src/Tabs.tsx 修改TabsProps接口,移除部分属性并新增type属性
src/interface.ts 移除RenderTabBarProps中的panes属性
tests/index.test.tsx 删除与panes相关的测试用例

诗歌

🐰 标签页重构,代码飞舞
旧属性告别,新逻辑绽放
精简优雅,兔子微笑
组件进化,如春风轻扫
重构之路,代码更强!


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

11-13: 建议添加函数文档注释

虽然实现逻辑变得更简洁了,但建议为组件添加 JSDoc 注释,说明:

  1. renderTabBar 属性的用途
  2. 移除 panes 支持的原因
  3. 新的使用方式示例

建议添加如下文档:

+/**
+ * TabNavList 的包装组件,用于支持自定义渲染 tabBar
+ * @param renderTabBar - 自定义渲染函数,不再支持 panes 属性
+ * @param restProps - 传递给 TabNavList 的其他属性
+ */
const TabNavListWrapper: React.FC<TabNavListWrapperProps> = ({ renderTabBar, ...restProps }) => {
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 9cfae99 and fab68aa.

📒 Files selected for processing (6)
  • docs/demo/renderTabBar-use-panes.md (0 hunks)
  • docs/examples/renderTabBar-use-panes.tsx (0 hunks)
  • src/TabNavList/Wrapper.tsx (1 hunks)
  • src/Tabs.tsx (0 hunks)
  • src/interface.ts (0 hunks)
  • tests/index.test.tsx (0 hunks)
💤 Files with no reviewable changes (5)
  • docs/demo/renderTabBar-use-panes.md
  • tests/index.test.tsx
  • src/interface.ts
  • docs/examples/renderTabBar-use-panes.tsx
  • src/Tabs.tsx
🔇 Additional comments (2)
src/TabNavList/Wrapper.tsx (2)

6-8: 类型定义清晰且合理!

类型定义使用了 TypeScript 的工具类型,很好地处理了必需和可选属性的关系。


Line range hint 18-20: 开发模式下的命名设置得当!

为组件设置 displayName 有助于调试和开发体验,这是一个很好的实践。

Copy link

codecov bot commented Jan 17, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.96%. Comparing base (9cfae99) to head (fab68aa).

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #768      +/-   ##
==========================================
- Coverage   98.96%   98.96%   -0.01%     
==========================================
  Files          18       18              
  Lines         774      771       -3     
  Branches      224      227       +3     
==========================================
- Hits          766      763       -3     
  Misses          8        8              

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

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