feat: add showHoverValue option #934

Meet-student · 2025-07-23T14:41:54Z

🤔 This is a ...

🔗 Related Issues

close Disable TimePicker's preview on hover ant-design/ant-design#54405

💡 Background and Solution

The specific problem to be addressed.

List the final API implementation and usage if needed.

If there are UI/interaction changes, consider providing screenshots or GIFs.

📝 Change Log

Read Keep a Changelog! Track your changes, like a cat tracks a laser pointer.

Describe the impact of the changes on developers, not the solution approach.

Reference: https://ant.design/changelog

Language	Changelog
🇺🇸 English	add showPreviewValue option
🇨🇳 Chinese	add showPreviewValue option

Summary by CodeRabbit

新功能
- 为 Picker 和 RangePicker 组件新增 showHoverValue 属性，可控制在悬浮日期时输入框是否临时显示预览值，默认开启。
文档
- 更新了组件 API 文档，补充了 showHoverValue 属性说明，并修正了表格格式。
- 示例代码中新增 showHoverValue 为 false 的用例，便于理解属性效果。
测试
- 增加了相关测试用例，确保当 showHoverValue 设为 false 时，悬浮不会影响输入框显示。

vercel · 2025-07-23T14:41:58Z

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

Name	Status	Preview	Comments	Updated (UTC)
picker	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Jul 24, 2025 1:55pm

coderabbitai · 2025-07-23T15:25:30Z

Walkthrough

此次更改将 showPreviewValue 属性重命名为 showHoverValue，用于控制在面板悬浮时输入框是否预览悬浮值。相关 Picker 组件、示例、接口、文档和测试均新增或更新了该属性及对应的逻辑和用例。

Changes

文件/分组	变更摘要
docs/examples/basic.tsx docs/examples/range.tsx docs/examples/time.tsx	新增 `showHoverValue: false` 的示例展示，调整样式和少量语法修正。
src/PickerInput/RangePicker.tsx src/PickerInput/SinglePicker.tsx	将 `showPreviewValue` 重命名为 `showHoverValue`，默认值 `true`，并在面板悬浮时根据该值决定是否更新预览值。
src/interface.tsx	在 `SharedPickerProps` 接口中新增可选属性 `showHoverValue`。
tests/range.spec.tsx tests/time.spec.tsx	新增测试用例验证 `showHoverValue: false` 时悬浮面板不更新输入框预览值，包含 hover 行为的模拟与断言。
README.md	更新文档，新增 `showHoverValue` 属性说明及默认值，修正表格格式。

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Picker/RangePicker
    participant InputField
    participant Panel

    User->>Picker/RangePicker: 打开选择面板
    User->>Panel: 悬浮某个单元格
    alt showHoverValue = true
        Panel->>Picker/RangePicker: 触发 onPanelHover
        Picker/RangePicker->>InputField: 更新预览值
    else showHoverValue = false
        Panel->>Picker/RangePicker: 触发 onPanelHover
        Picker/RangePicker-->>InputField: 不更新预览值
    end

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~45 minutes

Suggested reviewers

zombieJ
afc163

Poem

🐇
新增属性真灵巧，
预览值可控好。
测试示例都齐全，
代码清晰无烦恼。
兔子跳跃来祝贺，
Picker 功能更高妙！

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/PickerInput/RangePicker.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:1369:15)
at require.resolve (node:internal/modules/helpers:145:19)
at Object. (/.eslintrc.js:2:21)
at Module._compile (node:internal/modules/cjs/loader:1692:14)
at Object..js (node:internal/modules/cjs/loader:1824:10)
at Module.load (node:internal/modules/cjs/loader:1427:32)
at Module._load (node:internal/modules/cjs/loader:1250:12)
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:1449:12)

src/PickerInput/SinglePicker.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:1369:15)
at require.resolve (node:internal/modules/helpers:145:19)
at Object. (/.eslintrc.js:2:21)
at Module._compile (node:internal/modules/cjs/loader:1692:14)
at Object..js (node:internal/modules/cjs/loader:1824:10)
at Module.load (node:internal/modules/cjs/loader:1427:32)
at Module._load (node:internal/modules/cjs/loader:1250:12)
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:1449:12)

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.

📜 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 9bb291b and 99a78ed.

📒 Files selected for processing (2)

src/PickerInput/RangePicker.tsx (3 hunks)
src/PickerInput/SinglePicker.tsx (3 hunks)

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

src/PickerInput/RangePicker.tsx
src/PickerInput/SinglePicker.tsx

✨ Finishing Touches

📝 Generate Docstrings

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a 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.

❤️ 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.
- 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 @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @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 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 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 generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai generate unit tests to generate unit tests 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 · 2025-07-24T01:35:27Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.80%. Comparing base (d3dc263) to head (4e75254).

Additional details and impacted files

@@           Coverage Diff           @@
##           master     #934   +/-   ##
=======================================
  Coverage   98.80%   98.80%           
=======================================
  Files          65       65           
  Lines        2669     2673    +4     
  Branches      742      719   -23     
=======================================
+ Hits         2637     2641    +4     
  Misses         29       29           
  Partials        3        3

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

afc163 · 2025-07-24T01:36:20Z

src/PickerInput/SinglePicker.tsx

@@ -433,7 +435,9 @@ function Picker<DateType extends object = any>(

  // ======================== Panel =========================
  const onPanelHover = (date: DateType | null) => {
-    setInternalHoverValue(date);
+    if (showPreviewValue) {


showHoverValue 如何？

showHoverValue 如何？

类 Select 组件之后也可以支持一下这个功能

@afc163 @zombieJ done

feat: add showPreviewValue option

555a775

Meet-student marked this pull request as draft July 23, 2025 14:42

vercel bot deployed to Preview July 23, 2025 14:42 View deployment

Meet-student changed the title ~~feat: add showPreviewValue option~~ [WIP]feat: add showPreviewValue option Jul 23, 2025

feat: update test

4e75254

vercel bot deployed to Preview July 23, 2025 15:26 View deployment

Meet-student changed the title ~~[WIP]feat: add showPreviewValue option~~ feat: add showPreviewValue option Jul 23, 2025

Meet-student marked this pull request as ready for review July 23, 2025 15:26

afc163 reviewed Jul 24, 2025

View reviewed changes

feat: update

9bb291b

Meet-student changed the title ~~feat: add showPreviewValue option~~ feat: add showHoverValue option Jul 24, 2025

vercel bot deployed to Preview July 24, 2025 05:47 View deployment

feat: update onPanelHover

99a78ed

Meet-student requested review from afc163 and zombieJ July 24, 2025 13:55

vercel bot deployed to Preview July 24, 2025 13:55 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

feat: add showHoverValue option #934

feat: add showHoverValue option #934

Meet-student commented Jul 23, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Jul 23, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Jul 23, 2025 •

edited

Loading

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codecov bot commented Jul 24, 2025

Uh oh!

afc163 Jul 24, 2025

Uh oh!

zombieJ Jul 24, 2025

Uh oh!

Meet-student Jul 24, 2025

Uh oh!

Uh oh!

Uh oh!

feat: add showHoverValue option #934

Are you sure you want to change the base?

feat: add showHoverValue option #934

Conversation

Meet-student commented Jul 23, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🤔 This is a ...

🔗 Related Issues

💡 Background and Solution

📝 Change Log

Summary by CodeRabbit

Uh oh!

vercel bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Jul 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Estimated code review effort

Suggested reviewers

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codecov bot commented Jul 24, 2025

Codecov Report

Uh oh!

afc163 Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

zombieJ Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Meet-student Jul 24, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Meet-student commented Jul 23, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Jul 23, 2025 •

edited

Loading

coderabbitai bot commented Jul 23, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)