From 40329b423d82076756122024eba0b2106bfbf49c Mon Sep 17 00:00:00 2001 From: anlyyao Date: Mon, 20 Apr 2026 16:54:32 +0800 Subject: [PATCH 1/3] feat(Form): update interface FormInstanceFunctions --- db/TDesign.db | Bin 1134592 -> 1134592 bytes .../src/form/form.en-US.md | 7 ++ .../tdesign-mobile-react/src/form/form.md | 7 ++ .../tdesign-mobile-react/src/form/type.ts | 40 ++++++++++ .../packages/components/form/form.en-US.md | 1 + .../packages/components/form/form.md | 1 + .../packages/components/form/type.ts | 4 + packages/scripts/api.json | 75 +++++++++++++++--- 8 files changed, 123 insertions(+), 12 deletions(-) diff --git a/db/TDesign.db b/db/TDesign.db index 83cdd707ee1873672d5242c802d1e635549f9cb1..9d8d75c3a4b3edba3a79d5aa74c7e7ba17a4d7e5 100644 GIT binary patch delta 409 zcmZoz;M%ajb%Hb_*F+g-RxSp;vaZII))dCADNK{98HJ{QuV!jx6xv=}!xaA&$URWT ztl7?1#0xBQI~GHUp=x zv9Tos11ASB2QLE$NVAYzeo-zXkEo}Q`no74G>2T8ZabosAL za<-aA21aJO1}3^j1_}liR;ET)M#fl#9E*w)D{Vk-3o6Y?wNt23D9g`G**@D;FjWcw D$LN#P delta 197 zcmZoz;M%ajb%Hb_(?l6(Rwf3$HqFMA))dCADNK{98JVVkuV!jxWZGU^!xaB@`u;Lz zt#-B|W*}w(Vpbq#+s;gMo=h}YGPr&RUGau{h>FfrAvfC8{xXW3$&o&iIl>z`Z$Ug}H diff --git a/packages/products/tdesign-mobile-react/src/form/form.en-US.md b/packages/products/tdesign-mobile-react/src/form/form.en-US.md index 8f392243f..33d8aa845 100644 --- a/packages/products/tdesign-mobile-react/src/form/form.en-US.md +++ b/packages/products/tdesign-mobile-react/src/form/form.en-US.md @@ -36,7 +36,14 @@ name | params | return | description className | String | - | className of component | N style | Object | - | CSS(Cascading Style Sheets),Typescript: `React.CSSProperties` | N clearValidate | `(fields?: Array)` | \- | required +currentElement | \- | `HTMLFormElement` | \- +getCurrentElement | \- | `HTMLFormElement` | \- +getFieldValue | `(field: NamePath) ` | `unknown` | required +getFieldsValue | `(nameList: string[] \| boolean)` | `getFieldsValue` | required。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/form/type.ts)。
`interface getFieldsValue{ (nameList: true): T; (nameList: any[]): Record;}`
+getValidateMessage | `(fields?: Array)` | `Array \| voi` | required reset | `(params?: FormResetParams)` | \- | required。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/form/type.ts)。
`interface FormResetParams { type?: 'initial' \| 'empty'; fields?: Array }`
+setFields | `(fields: FieldData[])` | \- | required。Typescript: `(fields: FieldData[]) => void` `interface FieldData { name: NamePath; value?: unknown, status?: string, validateMessage?: { type?: string, message?: string } }`。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/form/type.ts) +setFieldsValue | `(field: Data)` | \- | required setValidateMessage | `(message: FormValidateMessage)` | \- | required。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/form/type.ts)。
`type FormValidateMessage = { [field in keyof FormData]: FormItemValidateMessage[] }`

`interface FormItemValidateMessage { type: 'warning' \| 'error'; message: string }`
submit | `(params?: { showErrorMessage?: boolean })` | \- | required validate | `(params?: FormValidateParams)` | `Promise>` | required。[see more ts definition](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/form/type.ts)。
`interface FormValidateParams { fields?: Array; showErrorMessage?: boolean; trigger?: ValidateTriggerType }`

`type ValidateTriggerType = 'blur' \| 'change' \| 'submit' \| 'all'`
diff --git a/packages/products/tdesign-mobile-react/src/form/form.md b/packages/products/tdesign-mobile-react/src/form/form.md index 18d352006..a958b34c5 100644 --- a/packages/products/tdesign-mobile-react/src/form/form.md +++ b/packages/products/tdesign-mobile-react/src/form/form.md @@ -36,7 +36,14 @@ onValuesChange | Function | | TS 类型:`(changedValues: Record)` | \- | 必需。清空校验结果。可使用 fields 指定清除部分字段的校验结果,fields 值为空则表示清除所有字段校验结果。清除邮箱校验结果示例:`clearValidate(['email'])` +currentElement | \- | `HTMLFormElement` | 获取 form dom 元素 +getCurrentElement | \- | `HTMLFormElement` | 获取 form dom 元素 +getFieldValue | `(field: NamePath) ` | `unknown` | 必需。获取单个字段值 +getFieldsValue | `(nameList: string[] \| boolean)` | `getFieldsValue` | 必需。获取一组字段名对应的值,当调用 getFieldsValue(true) 时返回所有表单数据。[详细类型定义](https://github.com/Tencent/tdesign-mobile-react/tree/develop/src/form/type.ts)。
`interface getFieldsValue{ (nameList: true): T; (nameList: any[]): Record;}`
+getValidateMessage | `(fields?: Array)` | `Array \| voi` | 必需。获取校验结果,当调用 getValidateMessage() 时返回所有校验结果 reset | `(params?: FormResetParams)` | \- | 必需。重置表单,表单里面没有重置按钮`