feat: add activeOptionFilter prop and update combobox examples
按照原有的逻辑,会默认根据 input 字符串 startsWith 规则自动将匹配的第一项设置为 activate ,且这种行为写死不可配置。
我认为以上行为不对,匹配规则应当能可选地由用户自己配置。
我的修改使得用户可以自行定制匹配规则,详见代码里的两个例子
任意部分匹配(而不仅开头)
强制不匹配(很多时候用户希望按下 Enter 键会直接发起搜索,而不是自动选中第一项)
像B站搜索框就是不会默认 activate 第一个匹配项的
Summary by CodeRabbit
Summary by CodeRabbit
- 新功能
- Select 组件新增可选属性
activeOptionFilter,允许自定义搜索时激活选项的过滤逻辑。 - 文档和示例中增加了
activeOptionFilter的用法演示,包括自定义匹配和禁用高亮的场景。
- Select 组件新增可选属性
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 | Jun 12, 2025 2:17pm |
Walkthrough
本次更改为 Select 组件引入了新的可选属性 activeOptionFilter,允许开发者自定义在搜索时激活选项的过滤逻辑。相关文档、类型声明和上下文传递均已更新,并在示例中展示了该属性的实际用法。测试中也新增了对应的行为验证。
Changes
| 文件/分组 | 变更摘要 |
|---|---|
| README.md | 在 Select 组件 API 文档中新增 activeOptionFilter 属性说明。 |
| docs/examples/combobox.tsx | 新增两个使用 activeOptionFilter 的 Select 组件示例。 |
| src/OptionList.tsx | 支持通过 context 获取并应用 activeOptionFilter 进行激活项匹配。 |
| src/Select.tsx | 在 SelectProps 和 context 中新增可选属性 activeOptionFilter。 |
| src/SelectContext.ts | 在 SelectContextProps 接口中新增 activeOptionFilter 属性。 |
| tests/Combobox.test.tsx | 新增测试用例验证 activeOptionFilter 在 Combobox 模式下的行为。 |
Sequence Diagram(s)
sequenceDiagram
participant User
participant Select
participant OptionList
User->>Select: 输入搜索内容
Select->>OptionList: 传递 activeOptionFilter、searchValue 和 options
OptionList->>OptionList: 使用 activeOptionFilter 判断激活项
OptionList-->>Select: 返回激活项索引
Select-->>User: 高亮/滚动到对应选项
Possibly related PRs
- react-component/select#1146: 此 PR 优化了选项激活与滚动逻辑,本次 PR 在其基础上进一步引入了可自定义的
activeOptionFilter。
Suggested reviewers
- afc163
Poem
🥕
兔子敲键盘,代码添新意,
选项激活,过滤更随心。
搜索中间也能配,
高亮逻辑自定义。
组件升级喜盈盈,
代码花园又添新!
[!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/@[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:1405:15) at defaultResolveImpl (node:internal/modules/cjs/loader:1061:19) at resolveForCJSWithHooks (node:internal/modules/cjs/loader:1066:22) at Module._load (node:internal/modules/cjs/loader:1215:37) at TracingChannel.traceSync (node:diagnostics_channel:322:14) at wrapModuleLoad (node:internal/modules/cjs/loader:235:24) at Module.require (node:internal/modules/cjs/loader:1491:12) at require (node:internal/modules/helpers:135:16) at Object.
(/.eslintrc.js:1:14) at Module._compile (node:internal/modules/cjs/loader:1734:14)
📜 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 c023b4b52a806e9b042b32c5e76fce324df87487 and 477937145f6cced683088f716fa81714b9a27110.
📒 Files selected for processing (1)
src/Select.tsx(4 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- src/Select.tsx
✨ Finishing Touches
- [ ] 📝 Generate Docstrings
🧪 Generate Unit Tests
- [ ] Create PR with Unit Tests
- [ ] Commit Unit Tests in branch
activeFilterOption - [ ] Post Copyable Unit Tests in Comment
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.
🪧 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.Explain this complex logic.Open a follow-up GitHub issue for this discussion.
- Files and specific lines of code (under the "Files changed" tab): Tag
@coderabbitaiin a new review comment at the desired location with your query. Examples:@coderabbitai explain this code block.@coderabbitai modularize this function.
- PR comments: Tag
@coderabbitaiin 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 explain its main purpose.@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.
Support
Need help? Create a ticket on our support page for assistance with any issues or questions.
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 pauseto pause the reviews on a PR.@coderabbitai resumeto resume the paused reviews.@coderabbitai reviewto trigger an incremental review. This is useful when automatic reviews are disabled for the repository.@coderabbitai full reviewto do a full review from scratch and review all the files again.@coderabbitai summaryto regenerate the summary of the PR.@coderabbitai generate docstringsto generate docstrings for this PR.@coderabbitai generate sequence diagramto generate a sequence diagram of the changes in this PR.@coderabbitai auto-generate unit teststo generate unit tests for this PR.@coderabbitai resolveresolve all the CodeRabbit review comments.@coderabbitai configurationto show the current CodeRabbit configuration for the repository.@coderabbitai helpto get help.
Other keywords and placeholders
- Add
@coderabbitai ignoreanywhere in the PR description to prevent this PR from being reviewed. - Add
@coderabbitai summaryto generate the high-level summary at a specific location in the PR description. - Add
@coderabbitaianywhere in the PR title to generate the title automatically.
CodeRabbit Configuration File (.coderabbit.yaml)
- You can programmatically configure CodeRabbit by adding a
.coderabbit.yamlfile 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 Report
All modified and coverable lines are covered by tests :white_check_mark:
Project coverage is 98.23%. Comparing base (
7aa0c21) to head (4779371). Report is 7 commits behind head on master.
Additional details and impacted files
@@ Coverage Diff @@
## master #1156 +/- ##
=======================================
Coverage 98.23% 98.23%
=======================================
Files 38 38
Lines 1471 1473 +2
Branches 446 440 -6
=======================================
+ Hits 1445 1447 +2
Misses 26 26
:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.
:rocket: New features to boost your workflow:
- :snowflake: Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
- :package: JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.