TDesignOteam · Jay2138 · Sep 11, 2025
@@ -0,0 +1,21 @@
+:: BASE_DOC ::
+
+## API
+
+
+### FormItem Props
+
+name | type | default | description | required
+-- | -- | -- | -- | --
+style | Object | - | CSS(Cascading Style Sheets) | N
+custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
+arrow | Boolean | false | \- | N
+for | String | - | \- | N
+help | String / Slot | - | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
+label | String / Slot | '' | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
+label-align | String | - | options: left/right/top | N
+label-width | String / Number | - | \- | N
+name | String | - | \- | N
+required-mark | Boolean | undefined | \- | N
+rules | Array | - | Typescript：`Array<FormRule>` | N
+show-error-message | Boolean | undefined | \- | N
@@ -0,0 +1,21 @@
+:: BASE_DOC ::
+
+## API
+
+
+### FormItem Props
+
+名称 | 类型 | 默认值 | 描述 | 必传
+-- | -- | -- | -- | --
+style | Object | - | 样式 | N
+custom-style | Object | - | 样式，一般用于开启虚拟化组件节点场景 | N
+arrow | Boolean | false | 是否显示右侧箭头 | N
+for | String | - | label 原生属性 | N
+help | String / Slot | - | 表单项说明内容。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
+label | String / Slot | '' | 字段标签名称。[通用类型定义](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
+label-align | String | - | 表单字段标签对齐方式：左对齐、右对齐、顶部对齐。默认使用 Form 的对齐方式，优先级高于 Form.labelAlign。可选项：left/right/top | N
+label-width | String / Number | - | 可以整体设置标签宽度，优先级高于 Form.labelWidth | N
+name | String | - | 表单字段名称 | N
+required-mark | Boolean | undefined | 是否显示必填符号（*），优先级高于 Form.requiredMark | N
+rules | Array | - | 表单字段校验规则。TS 类型：`Array<FormRule>` | N
+show-error-message | Boolean | undefined | 校验不通过时，是否显示错误提示信息，优先级高于 `Form.showErrorMessage` | N
@@ -0,0 +1,57 @@
+/* eslint-disable */
+
+/**
+ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
+ * */
+
+import { TdFormItemProps } from './type';
+const props: TdFormItemProps = {
+  /** 是否显示右侧箭头 */
+  arrow: {
+    type: Boolean,
+    value: false,
+  },
+  /** label 原生属性 */
+  for: {
+    type: String,
+    value: '',
+  },
+  /** 表单项说明内容 */
+  help: {
+    type: String,
+  },
+  /** 字段标签名称 */
+  label: {
+    type: String,
+    value: '',
+  },
+  /** 表单字段标签对齐方式：左对齐、右对齐、顶部对齐。默认使用 Form 的对齐方式，优先级高于 Form.labelAlign */
+  labelAlign: {
+    type: String,
+  },
+  /** 可以整体设置标签宽度，优先级高于 Form.labelWidth */
+  labelWidth: {
+    type: null,
+  },
+  /** 表单字段名称 */
+  name: {
+    type: String,
+    value: '',
+  },
+  /** 是否显示必填符号（*），优先级高于 Form.requiredMark */
+  requiredMark: {
+    type: null,
+    value: undefined,
+  },
+  /** 表单字段校验规则 */
+  rules: {
+    type: Array,
+  },
+  /** 校验不通过时，是否显示错误提示信息，优先级高于 `Form.showErrorMessage` */
+  showErrorMessage: {
+    type: null,
+    value: undefined,
+  },
+};
+
+export default props;
@@ -0,0 +1,82 @@
+/* eslint-disable */
+
+/**
+ * 该文件为脚本自动生成文件，请勿随意修改。如需修改请联系 PMC
+ * */
+
+export interface TdFormItemProps {
+  /**
+   * 是否显示右侧箭头
+   * @default false
+   */
+  arrow?: {
+    type: BooleanConstructor;
+    value?: boolean;
+  };
+  /**
+   * label 原生属性
+   * @default ''
+   */
+  for?: {
+    type: StringConstructor;
+    value?: string;
+  };
+  /**
+   * 表单项说明内容
+   */
+  help?: {
+    type: StringConstructor;
+    value?: string;
+  };
+  /**
+   * 字段标签名称
+   * @default ''
+   */
+  label?: {
+    type: StringConstructor;
+    value?: string;
+  };
+  /**
+   * 表单字段标签对齐方式：左对齐、右对齐、顶部对齐。默认使用 Form 的对齐方式，优先级高于 Form.labelAlign
+   */
+  labelAlign?: {
+    type: StringConstructor;
+    value?: 'left' | 'right' | 'top';
+  };
+  /**
+   * 可以整体设置标签宽度，优先级高于 Form.labelWidth
+   */
+  labelWidth?: {
+    type: null;
+    value?: string | number;
+  };
+  /**
+   * 表单字段名称
+   * @default ''
+   */
+  name?: {
+    type: StringConstructor;
+    value?: string;
+  };
+  /**
+   * 是否显示必填符号（*），优先级高于 Form.requiredMark
+   */
+  requiredMark?: {
+    type: BooleanConstructor;
+    value?: boolean;
+  };
+  /**
+   * 表单字段校验规则
+   */
+  rules?: {
+    type: ArrayConstructor;
+    value?: Array<FormRule>;
+  };
+  /**
+   * 校验不通过时，是否显示错误提示信息，优先级高于 `Form.showErrorMessage`
+   */
+  showErrorMessage?: {
+    type: BooleanConstructor;
+    value?: boolean;
+  };
+}
@@ -0,0 +1,102 @@
+:: BASE_DOC ::
+
+## API
+
+### Form Props
+
+name | type | default | description | required
+-- | -- | -- | -- | --
+style | Object | - | CSS(Cascading Style Sheets) | N
+custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
+colon | Boolean | false | \- | N
+data | Object | {} | Typescript：`FormData` | N
+disabled | Boolean | undefined | \- | N
+error-message | Object | - | Typescript：`FormErrorMessage` | N
+label-align | String | right | options: left/right/top | N
+label-width | String / Number | '81px' | \- | N
+readonly | Boolean | undefined | \- | N
+required-mark | Boolean | undefined | \- | N
+required-mark-position | String | - | Display position of required symbols。options: left/right | N
+reset-type | String | empty | options: empty/initial | N
+rules | Object | - | Typescript：`FormRules<FormData>` `type FormRules<T extends Data = any> = { [field in keyof T]?: Array<FormRule> }`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/form/type.ts) | N
+scroll-to-first-error | String | - | options: ''/smooth/auto | N
+show-error-message | Boolean | true | \- | N
+submit-with-warning-message | Boolean | false | \- | N
+
+### Form Events
+
+name | params | description
+-- | -- | --
+reset | `(detail: { e?: FormResetEvent })` | \-
+submit | `(context: SubmitContext<FormData>)` | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/form/type.ts)。<br/>`interface SubmitContext<T extends Data = Data> { e?: FormSubmitEvent; validateResult: FormValidateResult<T>; firstError?: string; fields?: any }`<br/><br/>`type FormValidateResult<T> = boolean \| ValidateResultObj<T>`<br/><br/>`type ValidateResultObj<T> = { [key in keyof T]: boolean \| ValidateResultList }`<br/><br/>`type ValidateResultList = Array<AllValidateResult>`<br/><br/>`type AllValidateResult = CustomValidateObj \| ValidateResultType`<br/><br/>`interface ValidateResultType extends FormRule { result: boolean }`<br/><br/>`type ValidateResult<T> = { [key in keyof T]: boolean \| ErrorList }`<br/><br/>`type ErrorList = Array<FormRule>`<br/>
+validate | `(result: ValidateResultContext<FormData>)` | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/form/type.ts)。<br/>`type ValidateResultContext<T extends Data> = Omit<SubmitContext<T>, 'e'>`<br/>
+
+### FormInstanceFunctions 组件实例方法
+
+name | params | return | description
+-- | -- | -- | --
+clear-validate | `(fields?: Array<keyof FormData>)` | \- | required
+reset | `(params?: FormResetParams<FormData>)` | \- | required。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/form/type.ts)。<br/>`interface FormResetParams<FormData> { type?: 'initial' \| 'empty'; fields?: Array<keyof FormData> }`<br/>
+set-validate-message | `(message: FormValidateMessage<FormData>)` | \- | required。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/form/type.ts)。<br/>`type FormValidateMessage<FormData> = { [field in keyof FormData]: FormItemValidateMessage[] }`<br/><br/>`interface FormItemValidateMessage { type: 'warning' \| 'error'; message: string }`<br/>
+submit | `(params?: { showErrorMessage?: boolean })` | \- | required
+validate | `(params?: FormValidateParams)` | `Promise<FormValidateResult<FormData>>` | required。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/form/type.ts)。<br/>`interface FormValidateParams { fields?: Array<string>; showErrorMessage?: boolean; trigger?: ValidateTriggerType }`<br/><br/>`type ValidateTriggerType = 'blur' \| 'change' \| 'submit' \| 'all'`<br/>
+
+
+### FormItem Props
+
+name | type | default | description | required
+-- | -- | -- | -- | --
+style | Object | - | CSS(Cascading Style Sheets) | N
+custom-style | Object | - | CSS(Cascading Style Sheets)，used to set style on virtual component | N
+arrow | Boolean | false | \- | N
+for | String | - | \- | N
+help | String / Slot | - | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
+label | String / Slot | '' | [see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/common/common.ts) | N
+label-align | String | - | options: left/right/top | N
+label-width | String / Number | - | \- | N
+name | String | - | \- | N
+required-mark | Boolean | undefined | \- | N
+rules | Array | - | Typescript：`Array<FormRule>` | N
+show-error-message | Boolean | undefined | \- | N
+
+### FormRule
+
+name | type | default | description | required
+-- | -- | -- | -- | --
+boolean | Boolean | - | \- | N
+date | Boolean / Object | - | Typescript：`boolean \| IsDateOptions` `interface IsDateOptions { format: string; strictMode: boolean; delimiters: string[] }`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/form/type.ts) | N
+email | Boolean / Object | - | Typescript：`boolean \| IsEmailOptions` `import { IsEmailOptions } from 'validator/es/lib/isEmail'`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/form/type.ts) | N
+enum | Array | - | Typescript：`Array<string>` | N
+idcard | Boolean | - | \- | N
+len | Number / Boolean | - | \- | N
+max | Number / Boolean | - | \- | N
+message | String | - | \- | N
+min | Number / Boolean | - | \- | N
+number | Boolean | - | \- | N
+pattern | String / Object | - | Typescript：`RegExp \| string` | N
+required | Boolean | - | \- | N
+telnumber | Boolean | - | \- | N
+trigger | String | change | Typescript：`ValidateTriggerType` | N
+type | String | error | options: error/warning | N
+url | Boolean / Object | - | Typescript：`boolean \| IsURLOptions` `import { IsURLOptions } from 'validator/es/lib/isURL'`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/form/type.ts) | N
+validator | Function | - | Typescript：`CustomValidator` `type CustomValidator = (val: ValueType) => CustomValidateResolveType \| Promise<CustomValidateResolveType>` `type CustomValidateResolveType = boolean \| CustomValidateObj` `interface CustomValidateObj { result: boolean; message: string; type?: 'error' \| 'warning' \| 'success' }` `type ValueType = any`。[see more ts definition](https://github.com/Tencent/tdesign-miniprogram/blob/develop/packages/components/form/type.ts) | N
+whitespace | Boolean | - | \- | N
+
+### FormErrorMessage
+
+name | type | default | description | required
+-- | -- | -- | -- | --
+boolean | String | - | \- | N
+date | String | - | \- | N
+enum | String | - | \- | N
+idcard | String | - | \- | N
+len | String | - | \- | N
+max | String | - | \- | N
+min | String | - | \- | N
+number | String | - | \- | N
+pattern | String | - | \- | N
+required | String | - | \- | N
+telnumber | String | - | \- | N
+url | String | - | \- | N
+validator | String | - | \- | N
+whitespace | String | - | \- | N