feat: 补充 FormItem 文档 getValueProps 接口额外说明

LongHaoo · Dec 16, 2023 · 399f780 · 399f780
1 parent 3a2cf49
commit 399f780
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/components/form/index.en-US.md b/components/form/index.en-US.md
@@ -123,7 +123,7 @@ Form field component for data bidirectional binding, validation, layout, and so
 | dependencies | Set the dependency field. See [below](#dependencies) | [NamePath](#namepath)\[] | - |  |
 | extra | The extra prompt message. It is similar to help. Usage example: to display error message and prompt message at the same time | ReactNode | - |  |
 | getValueFromEvent | Specify how to get value from event or other onChange arguments | (..args: any\[]) => any | - |  |
-| getValueProps | Additional props with sub component | (value: any) => any | - | 4.2.0 |
+| getValueProps | Additional props with sub component (It's not recommended to generate dynamic function prop by getValueProps. Please pass it to child component directly) | (value: any) => Record<string, any> | - | 4.2.0 |
 | hasFeedback | Used with `validateStatus`, this option specifies the validation status icon. Recommended to be used only with `Input`. Also, It can get feedback icons via icons prop. | boolean \| { icons: [FeedbackIcons](#feedbackicons) } | false | icons: 5.9.0 |
 | help | The prompt message. If not provided, the prompt message will be generated by the validation rule. | ReactNode | - |  |
 | hidden | Whether to hide Form.Item (still collect and validate value) | boolean | false | 4.4.0 |

diff --git a/components/form/index.zh-CN.md b/components/form/index.zh-CN.md
@@ -124,7 +124,7 @@ const validateMessages = {
 | dependencies | 设置依赖字段，说明[见下](#dependencies) | [NamePath](#namepath)\[] | - |  |
 | extra | 额外的提示信息，和 `help` 类似，当需要错误信息和提示文案同时出现时，可以使用这个。 | ReactNode | - |  |
 | getValueFromEvent | 设置如何将 event 的值转换成字段值 | (..args: any\[]) => any | - |  |
-| getValueProps | 为子元素添加额外的属性 | (value: any) => any | - | 4.2.0 |
+| getValueProps | 为子元素添加额外的属性 (不建议通过 `getValueProps` 生成动态函数 prop，请直接将其传递给子组件) | (value: any) => Record<string, any> | - | 4.2.0 |
 | hasFeedback | 配合 `validateStatus` 属性使用，展示校验状态图标，建议只配合 Input 组件使用 此外，它还可以通过 Icons 属性获取反馈图标。 | boolean \| { icons: [FeedbackIcons](#feedbackicons) } | false | icons: 5.9.0 |
 | help | 提示信息，如不设置，则会根据校验规则自动生成 | ReactNode | - |  |
 | hidden | 是否隐藏字段（依然会收集和校验字段） | boolean | false | 4.4.0 |