Skip to content

fix(Form): Form 组件文档 demo 中 Switch 组件使用问题 #2774

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

Merged
merged 2 commits into from
Nov 20, 2024

Conversation

zhangminggeek
Copy link
Contributor

@zhangminggeek zhangminggeek commented Nov 20, 2024

🤔 这个变动的性质是?

  • 新特性提交
  • 日常 bug 修复
  • 站点、文档改进
  • 演示代码改进
  • 组件样式/交互改进
  • TypeScript 定义更新
  • 包体积优化
  • 性能优化
  • 功能增强
  • 国际化改进
  • 重构
  • 代码风格优化
  • 测试用例
  • 分支合并
  • 其他改动(是关于什么的改动?)

🔗 相关 Issue

💡 需求背景和解决方案

Form 文档中使用 Switch 组件时没有指定 valuePropName,这会导致通过 setFieldsValue 赋值不生效

☑️ 请求合并前的自查清单

⚠️ 请自检并全部勾选全部选项⚠️

  • 文档已补充或无须补充
  • 代码演示已提供或无须提供
  • TypeScript 定义已补充或无须补充
  • fork仓库代码是否为最新避免文件冲突
  • Files changed 没有 package.json lock 等无关文件

Summary by CodeRabbit

  • 新特性
    • Demo7 组件的开关输入中,添加了 valuePropName="checked" 属性,以正确管理开关的状态。
    • 更新了 TextArea 组件的 placeholder 处理逻辑,改为基于语言环境动态赋值。

Copy link

coderabbitai bot commented Nov 20, 2024

Walkthrough

此拉取请求对 Demo7 组件中的 Form.Item 组件进行了修改,主要是为开关输入添加了 valuePropName="checked" 属性。这一更改确保开关的状态正确绑定到表单的 checked 属性上。同时,TextArea 组件的 defaultProps 也进行了调整,去除了 placeholder 的默认值并改为基于 locale 动态赋值。没有其他逻辑、错误处理或控制流的更改。

Changes

文件路径 更改摘要
src/packages/form/demos/h5/demo7.tsx 为开关输入的 Form.Item 添加了 valuePropName="checked" 属性。
src/packages/form/demos/taro/demo7.tsx 为开关输入的 Form.Item 添加了 valuePropName="checked" 属性。
src/packages/textarea/textarea.taro.tsx 更新了 TextArea 组件的 defaultProps,去除了 placeholder 属性的默认值,并根据 locale 动态赋值。
src/packages/textarea/textarea.tsx 更新了 TextArea 组件的 defaultProps,将 placeholder 的默认值从空字符串改为 undefined

Possibly related PRs

Suggested labels

size/S

🐇 在表单中轻轻跳,
开关状态不再小。
valuePropName 加上去,
绑定状态真美妙!
兔子欢呼声阵阵,
表单管理更简单!
🌟


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between d2341ac and f0a41fe.

📒 Files selected for processing (2)
  • src/packages/textarea/textarea.taro.tsx (0 hunks)
  • src/packages/textarea/textarea.tsx (0 hunks)
💤 Files with no reviewable changes (2)
  • src/packages/textarea/textarea.taro.tsx
  • src/packages/textarea/textarea.tsx

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

@github-actions github-actions bot added the 2.x Target branch 2.x label Nov 20, 2024
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 0

🧹 Outside diff range and nitpick comments (3)
src/packages/form/demos/h5/demo7.tsx (1)

61-63: 正确添加了 Switch 组件所需的 valuePropName 属性

valuePropName="checked" 的添加解决了 Switch 组件在 Form 中的使用问题,确保了 setFieldsValue 可以正确设置开关状态。

建议在代码注释中添加说明,解释为什么 Switch 组件需要设置 valuePropName="checked",这样可以帮助开发者更好地理解这个属性的用途。

+        {/* Switch 组件使用 checked 属性控制开关状态,因此需要设置 valuePropName="checked" */}
         <Form.Item label="Switch" name="switch" valuePropName="checked">
           <Switch />
         </Form.Item>
src/packages/form/demos/taro/demo7.tsx (2)

61-63: 修复正确,建议补充注释说明

valuePropName="checked" 的添加解决了 Switch 组件在 Form 中的使用问题,确保了 setFieldsValue 可以正确控制开关状态。

建议添加示例注释说明这个重要属性的用途:

+        {/* Switch 组件使用 checked 属性控制状态,需要设置 valuePropName="checked" */}
         <Form.Item label="Switch" name="switch" valuePropName="checked">
           <Switch />
         </Form.Item>

Line range hint 38-134: 建议为表单添加初始值示例

为了使示例更完整,建议添加 initialValues 属性来展示如何设置表单的默认值,特别是 Switch 组件的默认状态。

       <Form
         style={{ '--nutui-form-item-label-width': '120px' }}
+        initialValues={{
+          switch: true, // 设置 Switch 的默认值
+          form_input: '默认输入值',
+          // 其他表单项的默认值...
+        }}
         footer={
           // ... 现有代码 ...
         }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between bd4b46c and d2341ac.

📒 Files selected for processing (2)
  • src/packages/form/demos/h5/demo7.tsx (1 hunks)
  • src/packages/form/demos/taro/demo7.tsx (1 hunks)

Copy link

codecov bot commented Nov 20, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.07%. Comparing base (bd4b46c) to head (f0a41fe).
Report is 1 commits behind head on next.

Additional details and impacted files
@@            Coverage Diff            @@
##           next    #2774       +/-   ##
=========================================
+ Coverage      0   84.07%   +84.07%     
=========================================
  Files         0      217      +217     
  Lines         0    17830    +17830     
  Branches      0     2609     +2609     
=========================================
+ Hits          0    14991    +14991     
- Misses        0     2834     +2834     
- Partials      0        5        +5     

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


🚨 Try these New Features:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
2.x Target branch 2.x size/XS
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants