Skip to content

docs: remove legacy disabled prop references - #383

Merged
yoyo837 merged 2 commits into
react-component:masterfrom
nrps9909:codex/remove-disabled-doc
Aug 28, 2026
Merged

docs: remove legacy disabled prop references#383
yoyo837 merged 2 commits into
react-component:masterfrom
nrps9909:codex/remove-disabled-doc

Conversation

@nrps9909

@nrps9909nrps9909 commented Aug 28, 2026

Copy link
Copy Markdown
Contributor

Summary

  • remove the legacy disabled prop from the public API table
  • remove stale disabled and onSkipRender comments from the animation example

The two APIs were deliberately removed in commit 054f8ca as part of the legacy API cleanup, but the standardized README later listed disabled again. Keeping the documentation aligned with the current ListProps contract avoids suggesting an unsupported prop.

Fixes#311.

Validation

  • npm test -- --runInBand (8 suites, 280 tests)
  • npm run tsc
  • Prettier check for the changed files
  • ESLint for examples/animate.tsx (0 errors; 2 pre-existing warnings)
  • git diff --check

AI assistance disclosure

Codex was used to trace the API history, identify the stale documentation references, run validation, and draft this pull request. The final diff and test results were reviewed before submission.

Summary by CodeRabbit

  • 文档
    • 更新 List 组件 API 文档,移除已不再适用的 disabled 属性说明,确保公开文档与当前组件行为保持一致。
    • 同步更新中文文档中的相关 API 信息。
  • 示例
    • 清理动画示例中已注释的旧属性代码,示例内容更加简洁,不影响运行时行为。

@vercel

vercelBot commented Aug 28, 2026

Copy link
Copy Markdown

@nrps9909 is attempting to deploy a commit to the afc163's projects Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitaiBot commented Aug 28, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: bb64138a-9902-4a1e-9856-3aa899a872ed

📥 Commits

Reviewing files that changed from the base of the PR and between 226fdee and 3420fcf.

📒 Files selected for processing (1)
  • README.zh-CN.md
💤 Files with no reviewable changes (1)
  • README.zh-CN.md

Included review availability: Your plan provides up to 4 included reviews per hour; 3 remain after this review.


Walkthrough

本次变更移除 List API 文档中的 disabled 属性说明,并删除动画示例中的 disabledonSkipRender 注释代码。运行时行为未改变。

Changes

disabled 内容清理

Layer / File(s)Summary
清理 API 文档与动画示例
README.md, README.zh-CN.md, examples/animate.tsx
两个 README 文件删除 disabled 属性表格行。动画示例删除 disabledonSkipRender 注释属性。

Estimated code review effort: 1 (Trivial) | ~2 minutes

Merge Risk:⚪ Minimal · up to 3420f

This change removes obsolete API documentation without altering runtime behavior; no actionable merge-blocking risk remains after normal checks and review.

Poem

小兔删去旧注释,
API 表格变清晰。
disabled 不再列,
动画示例仍如昔。
代码安静跳起舞。

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check nameStatusExplanation
Description Check✅ PassedCheck skipped - CodeRabbit’s high-level summary is enabled.
Title check✅ Passed标题“docs: remove legacy disabled prop references”准确概括了本次变更:删除文档和示例中的旧版 disabled 引用。
Linked Issues check✅ Passed变更删除了 English 和 Chinese README 中未支持的 disabled API 文档,并清理了动画示例中的过时注释。这解决了 issue #311 中关于 disabled 未在 List 类型中声明且不可用所导致的文档契约不一致问题。
Out of Scope Changes check✅ Passed所有变更都集中于删除 disabled 和 onSkipRender 的过时文档或注释。未发现与 issue #311 或 PR 目标无关的代码变更。
Docstring Coverage✅ PassedNo functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Full details: Docstring Coverage

Explanation

No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0 files.

✨ Finishing Touches 💡 1
🛠️ Fix failing CI checks 💡
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests

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

Comment @coderabbitai help to get the list of available commands.

@yoyo837

Copy link
Copy Markdown
Member

And README.zh-CN.md elso.

@codecov

codecovBot commented Aug 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.60%. Comparing base (a573364) to head (3420fcf).

Additional details and impacted files
@@ Coverage Diff @@## master #383 +/- ##
=======================================
Coverage 97.60% 97.60% =======================================
Files 19 19 Lines 836 836 Branches 209 209 =======================================
Hits 816 816 Misses 20 20 

☔ View full report in Codecov by Harness.
📢 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.

@nrps9909

Copy link
Copy Markdown
ContributorAuthor

Added the matching README.zh-CN.md cleanup in 3420fcf. The unsupported disabled row is now removed from both API tables. git diff --check passes; the Chinese README has a pre-existing repository-wide Prettier mismatch at the parent commit, so I kept this follow-up to the requested one-line documentation change.

@yoyo837
yoyo837 merged commit 579a3bf into react-component:masterAug 28, 2026
11 of 12 checks passed
Sign up for freeto 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.

disable property is not wokring.

2 participants

@nrps9909@yoyo837