feat: [tabSelectsValue api]支持配置是否启用tab快捷键控制选中选项的逻辑

[astfn]

add the tabSelectsValue API to configure whether to enable the tab shortcut key to select options.
In certain scenarios, users need to customize the behavior of tab shortcuts externally.
I hope to merge my request, and if there are any unreasonable aspects, please let me know to make changes.
thanks.

Summary by CodeRabbit

• 新功能
  • 新增“tabSelectsValue”配置选项，允许用户自定义是否使用 Tab 键触发选中操作（默认开启）。
• 优化
  • 改进了组件的键盘事件处理逻辑，提升了整体使用体验。
• 测试
  • 增加了针对“tabSelectsValue”属性的测试用例，验证了不同配置下的行为。

[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	Mar 14, 2025 9:32am

[coderabbitai]

Walkthrough

本次 PR 在多个组件中引入了新的属性 tabSelectsValue，用于控制使用 Tab 键时是否触发选中操作。该属性默认为 true。在文档（README.md）中更新了 API 描述；在 OptionList.tsx 中，调整了 TAB 键的处理逻辑，以更清晰地表达条件；同时，在 Select.tsx 与 SelectContext.ts 中将该属性添加到各自的接口中，并在组件内部传递和使用此属性，从而统一并改进了键盘导航行为。

Changes

File(s)	Change Summary
README.md	更新文档，增加 tabSelectsValue 属性说明，类型为 boolean，默认值为 true。
src/OptionList.tsx	修改 TAB 键的处理逻辑，使用 selectOptionHotKeyLogic 函数处理选项选择逻辑。
src/Select.tsx, src/SelectContext.ts	在接口中新增 tabSelectsValue 属性；在 Select 组件中设置默认值为 true 并传递至上下文。
tests/OptionList.test.tsx	在 generateList 函数中新增 tabSelectsValue 属性，并增加测试用例以验证其行为。

Possibly related PRs

• fix: tab to select an active option #1078: 改进了 OptionList 组件的键盘导航和 Tab 键选中行为，与本次改动在功能上存在直接关联。

Suggested reviewers

• zombieJ

Poem

我是小兔，跳跃于代码间，
Tab键轻舞，选项展现新篇。
新属性点燃逻辑火花，
函数跃动，代码似画，
欢庆变更，愿未来路更宽！ 🐇✨

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.

tests/OptionList.test.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)

src/OptionList.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)

Tip

⚡🧪 Multi-step agentic review comment chat (experimental)

• We're introducing multi-step agentic chat in review comments. This experimental feature enhances review discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments.
  - To enable this feature, set early_access to true under in the settings.

---

📜 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 43b3b63 and f6cbf9a.

📒 Files selected for processing (2)

• src/OptionList.tsx (3 hunks)
• tests/OptionList.test.tsx (2 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

• src/OptionList.tsx

🔇 Additional comments (2)

tests/OptionList.test.tsx (2)

67-67: 添加了新属性 tabSelectsValue

在 SelectContext.Provider 中添加了 tabSelectsValue 属性并设置默认值为 true，这与 PR 中添加的新 API 功能一致。

---

248-287: 新增测试用例验证 tabSelectsValue 功能

这个测试用例很好地验证了当 tabSelectsValue 设置为 false 时的行为：Tab 键不会选中活动选项，但仍然会关闭下拉菜单。测试用例设计合理，覆盖了新增功能的关键场景。

测试步骤清晰：

1. 设置 tabSelectsValue: false
2. 打开下拉菜单
3. 选中一个选项
4. 按下 Tab 键
5. 验证选择未被触发
6. 验证菜单已关闭

这与已有的测试用例形成了良好的互补，共同验证了 Tab 键在不同配置下的行为。

✨ Finishing Touches

• 📝 Generate Docstrings

---

🪧 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.
• @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.27%. Comparing base (e8096c0) to head (f6cbf9a).
Report is 2 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1131      +/-   ##
==========================================
+ Coverage   98.26%   98.27%   +0.01%     
==========================================
  Files          39       39              
  Lines        1499     1509      +10     
  Branches      424      457      +33     
==========================================
+ Hits         1473     1483      +10     
  Misses         26       26              

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