type: onChange callback should define 'option' as Option | Option[] | undefined

[thinkasany]

close ant-design/ant-design#51789

Summary by CodeRabbit

• 新功能

  • 引入新的 API：listHeight、listItemHeight 和 component。

• 变更

  • 移除多个不再支持的 API，包括 multiple、tags 和 combobox。
  • 更新了 onChange 事件处理程序，返回 OptionData 而非 ReactNode。

• 可访问性增强

  • 为聚焦选择框设置了 aria-live="polite" 属性。

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
select	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 27, 2024 6:42am

[coderabbitai]

Walkthrough

此次更改对 src/Select.tsx 中的 Select 组件进行了显著修改。新增了 listHeight、listItemHeight 和 component 等 API，同时移除了多个已弃用的 API，包括 multiple、tags 和 combobox。onChange 事件处理程序现在返回 OptionData，并更新了相关的事件处理函数以支持新的数据类型。组件的可访问性功能也得到了增强，确保其符合可访问性要求。

Changes

文件	更改摘要
src/Select.tsx	新增 API：listHeight、listItemHeight、component；移除已弃用 API：multiple、tags、combobox、firstActiveValue、dropdownMenuStyle、openClassName；更新 onChange 方法签名以返回 OptionData。

Assessment against linked issues

Objective	Addressed	Explanation
Select component's onChange callback should define 'option' as Option	Option[]	✅
	❌	变更未完全满足对 option 参数的要求。

Possibly related PRs

• fix: aria-selected should not always set to false under combobox mode #1077: 此 PR 修改了 OptionList 组件，以增强 'combobox' 模式的可访问性功能，与主 PR 中对 Select 组件的相关更改直接相关。
• fix: tab to select an active option #1078: 此 PR 改进了选择活动选项的键盘导航，涉及主 PR 中对 Select 组件事件处理和状态管理的优化。
• fix: allow keyboard navigation on selected options when maxCount is reached #1088: 此 PR 解决了达到最大选择计数时的键盘导航行为，相关于主 PR 中对 Select 组件的可访问性和交互改进。

🐇 在草地上跳跃，组件焕新颜，
新增 API，旧的弃如烟。
可访问性提升，用户更欢颜，
选择更灵活，体验更自然。
兔子欢呼，代码如春天！ 🌼

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.

src/Select.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+eslintrc@2.1.4/node_modules/@eslint/eslintrc/dist/eslintrc.cjs
• /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/cli-engine/cli-engine.js
• /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/eslint/eslint.js
• /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/eslint/index.js
• /node_modules/.pnpm/eslint@8.57.1/node_modules/eslint/lib/cli.js
• /node_modules/.pnpm/eslint@8.57.1/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)

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between ec182e5 and fb0dc7e.

📒 Files selected for processing (1)

• src/Select.tsx (1 hunks)

🔇 Additional comments (1)

src/Select.tsx (1)

164-164: 修改符合预期，onChange回调的option参数已更新为可选

此更改使option参数在onChange回调中可为undefined，符合PR的目标，解决了在取消选择时option可能为undefined的问题。

---

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

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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 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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.24%. Comparing base (ec182e5) to head (fb0dc7e).
Report is 1 commits behind head on master.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1090   +/-   ##
=======================================
  Coverage   98.24%   98.24%           
=======================================
  Files          39       39           
  Lines        1483     1483           
  Branches      419      447   +28     
=======================================
  Hits         1457     1457           
  Misses         26       26           

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

[thinkasany]

@zombieJ 这个会发 patch 吗

[zombieJ]

我记得还有其他的 PR 要合并提一个 minor，应该要等等

[thinkasany]

我记得还有其他的 PR 要合并提一个 minor，应该要等等

是可以合进 master 的 minor 吗，但是如果变更大，抬进 feature 的话，用户可能就等的比较久了~ 希望没添乱，辛苦佬回复。