Skip to content

fix: improve field value handling and touched state merging in FormStore #752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: antd-5.x
Choose a base branch
from

Conversation

Wxh16144
Copy link
Contributor

@Wxh16144 Wxh16144 commented Jun 3, 2025

fix: ant-design/ant-design#53981

Summary by CodeRabbit

  • Bug Fixes

    • 优化了表单字段在设置值时的“已触碰”状态管理,确保字段值变更后正确标记为已触碰,有助于更准确地显示校验提示。
  • Tests

    • 修正了测试用例名称以反映实际功能。
    • 新增测试,验证通过设置字段值后字段会被正确标记为已触碰,提升表单交互的准确性。

Copy link

vercel bot commented Jun 3, 2025

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

Name Status Preview Comments Updated (UTC)
field-form ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jun 3, 2025 6:54am

Copy link

coderabbitai bot commented Jun 3, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

本次更改优化了 FormStore 类中 setFields 方法对字段元数据 touched 状态的管理逻辑,使 setFieldValuesetFieldsValue 的行为在设置字段值时保持一致。测试文件也新增并修正了相关用例以验证此行为。

Changes

文件/分组 变更摘要
src/useForm.ts 优化 setFields 方法,统一 touched 状态处理逻辑
tests/index.test.tsx 修正用例名称,新增测试验证 setFieldValue 会设置 touched

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Form
    participant FormStore

    User->>Form: 调用 setFieldValue/setFieldsValue
    Form->>FormStore: setFields
    FormStore->>FormStore: 检查并更新字段 touched 状态
    FormStore-->>Form: 通知字段变更(含合并后的 metadata)
    Form-->>User: 字段状态更新(touched 状态一致)
Loading

Assessment against linked issues

Objective Addressed Explanation
统一 setFieldValue 和 setFieldsValue 设置字段值时的 touched 行为 (#53981)

Suggested reviewers

  • zombieJ

Poem

兔子跳跃键盘旁,
字段 touched 皆相同。
setFieldValue 不再迷茫,
一致行为暖心房。
测试通过皆欢畅,
代码如春草生长!
🐇✨


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

Copy link

codecov bot commented Jun 3, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.44%. Comparing base (f9ac280) to head (f3382da).

Additional details and impacted files
@@            Coverage Diff            @@
##           antd-5.x     #752   +/-   ##
=========================================
  Coverage     99.44%   99.44%           
=========================================
  Files            18       18           
  Lines          1257     1269   +12     
  Branches        315      300   -15     
=========================================
+ Hits           1250     1262   +12     
  Misses            7        7           

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

@Wxh16144 Wxh16144 changed the base branch from master to antd-5.x June 3, 2025 06:52
if ('touched' in data) {
mergeTouched = data.touched;
} else if (hasValue && previousFieldMeta !== null) {
mergeTouched = !isEqual(this.getFieldValue(namePath), data.value)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

不能在 setFields 里改 touched 来解决 setFieldValue 里没有设置 touched 的问题。setFields 本身是底层操作,它只改传入的 meta。

应该是 setFieldValue 里直接加上 touched: true

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

应该是 setFieldValue 里直接加上 touched: true

value 没有 diff 也算吗?

Sign up for free to 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.

The behavior of form.setFieldValue and form.setFieldsValue is inconsistent.
2 participants