@para-ui/core 5.0.0-beta.11 → 5.0.0-beta.13

package/es/Form/component.json

@@ -0,0 +1,161 @@
+{
+    "name": "Form",
+    "category": "Data Entry",
+    "description": "基于配置的高性能表单组件",
+    "semantic": {
+        "intent": [
+            "数据录入",
+            "数据编辑",
+            "数据校验"
+        ],
+        "useCases": [
+            "登录注册",
+            "配置设置",
+            "信息填写"
+        ],
+        "riskLevel": "high"
+    },
+    "variants": {
+        "horizontal": {
+            "meaning": "水平布局表单"
+        },
+        "vertical": {
+            "meaning": "垂直布局表单"
+        }
+    },
+    "states": [
+        "loading",
+        "submitting",
+        "error"
+    ],
+    "idealProps": {
+        "configList": {
+            "type": "configListProps",
+            "description": "表单项配置数组（`type configListProps = Array<FormItemProps>`，src/Form/index.tsx:20 已 export）。**FormItemProps 核心字段（完整见 docs/view/form/api.ts apiDataFormItemProps）**：\n• `name: string`（必填，唯一标识；onChange / backData 的 key 都对应该值）\n• `label: string | ((props: FormItemProps) => ReactNode)`（显示文案）\n• `InputType: 'default' | 'number' | 'textarea' | 'select' | 'radioGroup' | 'checkGroup' | 'switch' | 'file' | FC<ItemTypeProps>`（⚠️ 控件类型用 **InputType**，不是 type；type 是布局覆盖）\n• `defaultValue: any`（字段初始值；backData[name] 优先级更高）\n• `rules: { validate: { required?, maxlength?, minLength?, pattern?, [customKey]? }, message: { [key]: string } }`（⚠️ **注意大小写**：`maxlength` 小写 l；`minLength` 驼峰 L——src 命名不一致，写错会导致校验规则被忽略）\n• `list: Array<{label, name?|value?}>`（radioGroup/checkGroup 子项用 `name`；select 子项用 `value`）\n• `disabled: boolean`（单项禁用）\n• `hide: boolean`（隐藏该项）\n• `hideError: boolean`（隐藏该项内置 error UI）\n• `type: 'vertical' | 'horizontal'`（单项布局覆盖；与顶层 type 同名，仅控制布局，不影响控件类型）"
+        },
+        "backData": {
+            "type": "{ [name: string]: any }",
+            "description": "整表回填数据。比 configList 中每项的 defaultValue 优先级更高；切换到该新对象会刷新表单。常配合 form.refreshForm(undefined, newBackData) 实现『换数据源』场景"
+        },
+        "type": {
+            "type": "enum",
+            "values": [
+                "vertical",
+                "horizontal"
+            ],
+            "default": "horizontal",
+            "description": "**布局类型**（vertical=竖 / horizontal=横）；configList 中每项的 `type` 字段可覆盖顶层布局。⚠️ **此处 type 仅控制布局，与控件类型无关**——控件类型用 FormItemProps.`InputType`（default/select/radioGroup 等）"
+        },
+        "disabled": {
+            "type": "boolean",
+            "default": false,
+            "description": "是否全局禁用所有 FormItem 输入控件——对所有 InputType（default/textarea/number/file/switch/select/radioGroup/checkGroup/自定义函数）都生效，FormItem 内部把顶层 disabled 透传给每项。disabled 期间用户交互被屏蔽，onChange 不触发；不影响 form.current.check / reset / clear 等命令式调用"
+        },
+        "onChange": {
+            "type": "function",
+            "signature": "(name: string, value: any) => void",
+            "description": "表单值改变回调——任意字段（任意 InputType）变化都触发。**name 参数 = 对应 configList 该项的 `name` 字段值**；value 为该字段当前值。**触发时机**：input 类等价 onInput 实时（非 onBlur）；select/radioGroup/checkGroup 在用户选中瞬时；switch 在 toggle 瞬时。**初始 backData 注入不触发 onChange**（仅用户交互或 form.current.refreshForm 才触发）。该回调不携带校验状态，需校验请用 form.current.check?.()"
+        },
+        "form": {
+            "type": "React.MutableRefObject<FormRefObject>",
+            "description": "**命令式 ref**——通过 form.current 调用 check / reset / clear / refreshForm / getValidValues 等方法。**FormRefObject 字段完整列表**（DEFECT-001/002）：check（校验，**返回 false | { [name]: any }**——失败返 false 不抛错；**成功返回的对象 key = configList 每项的 `name` 字段值**，扁平结构非嵌套）/ reset（重置到初始 backData/defaultValue）/ clear（清空全部或指定字段，签名 `(name?: string | string[]) => void`）/ items（{ [name]: ItemTypeProps }）/ values / refreshForm / refData / getValidValues（过滤 hide=true 与未通过校验的字段）。docs/view/form/api.ts 末尾 RefObject 表列出全部字段。**5.x 仅整表 check，无 checkField(name) 单字段校验 API**——逐字段实时校验需在父组件用 onChange 桥接 + 业务方复刻 validate 逻辑。**FormRefObject 已公开 export**（Form-DEFECT-001 起），通过 `import { FormRefObject } from '@para-ui/core'` 或 `import { FormRefObject } from '@para-ui/core/Form'` 获取精确类型；推荐声明：`const formRef = useRef<FormRefObject>({} as FormRefObject)`"
+        },
+        "getCheckForm": {
+            "type": "function",
+            "signature": "(checkFrom: Function) => void",
+            "description": "**与 form ref 是同一能力的双通路（DEFECT-005）**。回调式：组件挂载后调用 getCheckForm(check) 把 check 函数交给父组件。**推荐统一用 form ref**——getCheckForm 是历史回调式 API"
+        },
+        "getForcedRefresh": {
+            "type": "function",
+            "signature": "(setConfigHook: (configList: configListProps, bData?: { [name: string]: any }) => void) => void",
+            "description": "强制刷新配置回调（src/Form/index.tsx:96-102 interface 实证）：组件挂载后将内部 setConfig 方法交给父组件；父组件可通过 setConfigHook(newConfigList, newBackData) 命令式刷新整个表单结构和回填数据。⚠️ **推荐改用 form ref.refreshForm**——getForcedRefresh 是历史 API，与 form ref 功能重叠"
+        },
+        "disOnlySpace": {
+            "type": "boolean",
+            "description": "是否禁止纯空格提交（src/Form/index.tsx:111 interface 实证）：true 时 rules.validate.required + 纯空格内容也会校验失败"
+        },
+        "className": {
+            "type": "string",
+            "description": "表单容器自定义类名（src/Form/index.tsx:122 interface 实证）"
+        },
+        "labelWidth": {
+            "type": "number",
+            "description": "Label 区块宽度，仅在顶层 type='vertical' 时生效（src/Form/index.tsx:131 interface 实证）"
+        }
+    },
+    "do": [
+        "使用 configList 进行配置化开发以减少模版代码",
+        "利用 form ref 进行手动校验和数据获取（推荐 form 单一通路而非 getCheckForm 双通路）",
+        "提交场景：`const values = formRef.current.check?.(); if (!values) return; submit(values);`——check 校验失败返 false，不抛错",
+        "重置场景：调用 form.current.reset?.() 而非 refreshForm(schema, {})（DEFECT-002 reset 是真实存在的 API）",
+        "FormItem 字段默认值用 FormItemProps.defaultValue（DEFECT-003 已实现，docs api.ts apiDataFormItemProps 已补）",
+        "**FormItemProps.list 子项 key 命名按 InputType 选用**（DEFECT-008 + src 实证）：radioGroup / checkGroup 用 `{ label, name }`（用户选中产生的值 = name）；select 用 `{ label, value }`（用户选中产生的值 = value）",
+        "**rules.validate 合法 key**（src/FormItem/index.tsx:54-60 实证）：`required` / **`maxlength`**（小写 L）/ **`minLength`**（驼峰 L，与 maxlength 命名不一致是 src 现状）/ `pattern` / `disOnlySpace` / 任意自定义 key（值为 `(item, val) => boolean | string`）。message 中 key 与 validate key 一一对应",
+        "需要把同步 `check()` 包成 Promise 时：`async () => { const v = formRef.current.check?.(); return v || null; }`——失败返 null 而非 reject，避免业务方两套错误处理（参见 codeString.ts asyncCheckDemo）",
+        "需要逐字段实时校验：用顶层 onChange 桥接（任意字段变化都触发）+ 业务方在父组件复刻一份 validate 逻辑——5.x 没有 checkField(name) 单字段校验 API",
+        "需要父组件接管错误显示（服务端 / 异步校验）：更新 configList 对应项的 `errorMessage` 字段注入自定义错误文案（FormItem 优先展示此值，check() 内部错误被覆盖）；清除时传 `errorMessage: ''` 或 `undefined`。若需彻底隐藏内置 error UI 改用外部渲染，则配合 `hideError: true` + 父组件自定义 UI（议题 discussions/Form-error-takeover.md）"
+    ],
+    "dont": [
+        "在 render 中动态改变 configList 结构（应保持引用稳定）",
+        "混用受控和非受控模式",
+        "不要假设 check() 失败抛异常或返回 undefined——失败时返回 false（DEFECT-006）",
+        "不要既传 form 又传 getCheckForm 混用双通路（DEFECT-005）——选 form 即可",
+        "**不要在 select 子项里用 `{ label, name }`**——select 内部读 `value` 字段，用 name 会导致选中后 onChange 不传值；checkGroup/radioGroup 反过来要用 name 不能用 value（DEFECT-008 + src 实证）",
+        "**不要在 rules.validate 中把 maxlength 写成 maxLength（驼峰 L）或把 minLength 写成 minlength（小写 L）**——src 字段名严格匹配，写错会导致校验规则被忽略；不一致是 src 现状",
+        "不要假设 onChange 触发时携带校验状态——onChange 仅传 (name, value)，校验状态需主动调 form.current.check?.()",
+        "不要假设初始 backData 注入触发 onChange——src 实证仅用户交互或 form.current.refreshForm 触发"
+    ],
+    "events": {
+        "onChange": {
+            "signature": "(name: string, value: any) => void",
+            "asyncSupported": false,
+            "examples": [
+                "任意 FormItem 字段值变化时触发，name 是 configList 该项的 name 字段值",
+                "input 类等价 onInput 实时触发，select/radioGroup 在选中瞬时，switch 在 toggle 瞬时",
+                "桥接逐字段实时校验：拿到 (name, value) 后调 formRef.current.check?.() 触发整表校验"
+            ],
+            "commonMistakes": [
+                "假设回调签名是 (e, value) 类似 antd → 实际只有 (name, value) 两个参数",
+                "在 onChange 里直接做副作用而不通过 setState（破坏受控模式）",
+                "假设初始 backData 注入会触发 onChange → 不会，仅用户交互或 refreshForm 触发",
+                "假设 onChange 携带校验状态 → 不携带，需主动调 check?.()"
+            ]
+        }
+    },
+    "typescriptPitfalls": [
+        {
+            "issue": "FormRefObject 必须显式声明类型，否则 ref.current 推断为 unknown",
+            "wrong": "const formRef = useRef(null); formRef.current.check();  // 报 unknown 类型错",
+            "right": "import { FormRefObject } from '@para-ui/core'; const formRef = useRef<FormRefObject>({} as FormRefObject);"
+        },
+        {
+            "issue": "FormItem 控件类型字段叫 InputType 不是 type（type 是布局覆盖）",
+            "wrong": "configList: [{ name: 'age', label: '年龄', type: 'number' }]  // type 在这里是布局,不是控件",
+            "right": "configList: [{ name: 'age', label: '年龄', InputType: 'number' }]"
+        },
+        {
+            "issue": "rules.validate 字段名大小写不一致（src 现状）",
+            "wrong": "rules: { validate: { maxLength: 10, minlength: 2 } }  // 写错被忽略",
+            "right": "rules: { validate: { maxlength: 10, minLength: 2 } }  // 注意：maxlength 小写 L，minLength 驼峰 L"
+        },
+        {
+            "issue": "list 子项的 key 名称按 InputType 选用",
+            "wrong": "InputType: 'select', list: [{ label: 'A', name: 'a' }]  // select 读 value,name 被忽略",
+            "right": "InputType: 'select' → list: [{ label: 'A', value: 'a' }] // radioGroup/checkGroup 反过来用 name"
+        },
+        {
+            "issue": "check() 返回类型是 false | object,不是 boolean 也不抛异常",
+            "wrong": "const ok = formRef.current.check?.(); if (!ok) throw new Error('fail');  // ok 是 false | object",
+            "right": "const values = formRef.current.check?.(); if (!values) return; submit(values);  // false 表失败,object 表成功并含字段值"
+        },
+        {
+            "issue": "configList 不接受 undefined (TS2345),空状态用 '' 或 []",
+            "wrong": "<Form configList={someUndefined} />  // 触发 TS2345: Argument of type 'undefined' is not assignable to '\"\" | FormItemProps[]'",
+            "right": "<Form configList={someValue || []} />  // 或 configList=''"
+        }
+    ],
+    "mapping": {
+        "realComponent": "Form",
+        "adapter": null
+    }
+}

package/es/Form/index.d.ts

@@ -11,6 +11,50 @@ type FormHtmlProps = FormHTMLAttributes<HTMLFormElement>;
  * 配置项项类型
  */
 export type configListProps = Array<FormItemProps>;
+/**
+ * form ref 暴露的命令式 API（Form-DEFECT-001 起公开导出，业务方可 `import { FormRefObject } from '@para-ui/core/Form'`）
+ */
+export interface FormRefObject {
+    /**
+     * 校验表单方法，校验成功返回表单的键值对；失败返回 false（src jsdoc 实证）
+     * @return {false | {[name: string]: unknown}}
+     */
+    check?: Function;
+    /**
+     * 存储所有表单item最后的配置，方便提交时做总的校验
+     */
+    items?: {
+        [name: string]: ItemTypeProps;
+    };
+    /**
+     * 所有值
+     */
+    values?: {
+        [name: string]: unknown;
+    };
+    /**
+     * 强制刷新表单状态方法
+     */
+    refreshForm?: (list: Array<FormItemProps> | '', bData?: {
+        [name: string]: unknown;
+    }) => void;
+    /**
+     * 对象数据集合
+     */
+    refData?: RefDataProps;
+    /**
+     * 获取生效项目的值对象，会过滤掉不显示或是不启用的项目的值
+     */
+    getValidValues?: Function;
+    /**
+     * 重置表单
+     */
+    reset?: Function;
+    /**
+     * 清空表单数据，允许清空单个
+     */
+    clear?: (name?: string | string[]) => void;
+}
 /**
  * form 表单组件属性
  * @typedef {object} FormProps
@@ -20,51 +64,10 @@ export interface FormProps {
      * form 表单对象存储关键数据和校验方法
      * @property {Function} check 表单校验方法
      * @property {configListProps} items 配置项，最后经过加工的合计
-     * @property {{ [name: string]: any }} values 已经保存的值的键值对
+     * @property {{ [name: string]: unknown }} values 已经保存的值的键值对
      * @property {Function} refreshForm 强制刷新表单状态
      */
-    form?: React.MutableRefObject<{
-        /**
-         * 校验表单方法，校验成功返回表单的键值对
-         * @return {false | {[name: string]: any}}
-         */
-        check?: Function;
-        /**
-         * 存储所有表单item最后的配置，方便提交时做总的校验
-         */
-        items?: {
-            [name: string]: ItemTypeProps;
-        };
-        /**
-         * 所有值
-         */
-        values?: {
-            [name: string]: any;
-        };
-        /**
-         * 强制刷新表单状态方法
-         */
-        refreshForm?: (list: Array<FormItemProps> | '', bData?: {
-            [name: string]: any;
-        }) => void;
-        /**
-         * 对象数据集合
-         */
-        refData?: RefDataProps;
-        /**
-         * 获取生效项目的值对象，会过滤掉不显示或是不启用的项目的值，
-         */
-        getValidValues?: Function;
-        /**
-         * 重置表单
-         */
-        reset?: Function;
-        /**
-         * 清空表单数据
-         * 允许清空单个
-         */
-        clear?: (name?: string | string[]) => void;
-    }>;
+    form?: React.MutableRefObject<FormRefObject>;
     /**
      * from 表单的默认属性
      */
@@ -76,19 +79,19 @@ export interface FormProps {
     /**
      * 获取表单的校验方法，会传出表单的校验方法
      */
-    getCheckForm?: (checkFrom: Function) => {};
+    getCheckForm?: (checkFrom: Function) => void;
     /**
      * 输入框内容改变传出
      * @param {string} name 表单项的name
      * @param {any} value 当前表单输入项修改的值
      */
-    onChange?: (name: string, value: any) => void;
+    onChange?: (name: string, value: unknown) => void;
     /**
      * 强制刷新配置
      * @param {Function} configHook 传出内部设置表单项，和回填参数的 hook方法
      */
     getForcedRefresh?: (setConfigHook: (configList: configListProps, bData?: {
-        [name: string]: any;
+        [name: string]: unknown;
     }) => void) => void;
     /**
      * 表单项的配置
@@ -98,7 +101,7 @@ export interface FormProps {
      * 回填数据
      */
     backData?: {
-        [name: string]: any;
+        [name: string]: unknown;
     };
     /**
      * 是否禁用
@@ -136,7 +139,7 @@ export interface FormProps {
 /**
  * form 存储各种参数的集合类型
  */
-interface RefDataProps {
+export interface RefDataProps {
     /**
      * 存储所有表单item最后的配置，方便提交时做总的校验
      */
@@ -159,7 +162,7 @@ interface RefDataProps {
      * 表单保存的值集合
      */
     allValues: {
-        [name: string]: any;
+        [name: string]: unknown;
     };
     /**
      * 最新配置信息

package/es/Form/index.js

@@ -1,5 +1,5 @@
 import { j as p } from "../_virtual/jsx-runtime.js";
-import { DeepClone as N } from "@paraview/lib";
+import { DeepClone as N } from "@snack-kit/lib";
 import n from "react";
 import _ from "../FormItem/index.js";
 import w from "../FormItem/validateFunction.js";

package/es/FormItem/compoments/defaultCompoments/index.d.ts

@@ -1,13 +1,13 @@
-import { FC } from 'react';
+import { FC, ReactNode } from 'react';
 interface DefaultCompomentsProps {
-    moudle: any;
+    moudle: (props: object) => ReactNode;
     error: boolean;
     placeholder: string;
-    defaultValue: any;
+    defaultValue: unknown;
     disabled?: boolean;
-    onChange: (e: any) => void;
+    onChange: (e: unknown) => void;
     inputProps?: {
-        [name: string]: any;
+        [name: string]: unknown;
     };
 }
 /**

package/es/FormItem/compoments/defaultCompoments/index.js

@@ -1,22 +1,23 @@
+import { j as r } from "../../../_virtual/jsx-runtime.js";
 import l from "react";
-const h = (u) => {
-  const { error: r, placeholder: n, defaultValue: e, disabled: s, onChange: d, inputProps: c, moudle: f } = u, [m, t] = l.useState(e);
+const g = (u) => {
+  const { error: n, placeholder: s, defaultValue: e, disabled: d, onChange: m, inputProps: c, moudle: f } = u, [p, t] = l.useState(e);
   return l.useEffect(() => {
     t(e);
-  }, [e]), f({
-    error: r,
-    placeholder: n,
-    value: m,
-    disabled: s,
+  }, [e]), /* @__PURE__ */ r.jsx(r.Fragment, { children: f({
+    error: n,
+    placeholder: s,
+    value: p,
+    disabled: d,
     hideErrorDom: null,
     ...c,
     onChange: (a) => {
-      const o = a?.target?.value || a;
-      t(o), d(o);
+      const o = a?.target?.value ?? a;
+      t(o), m(o);
     }
-  });
+  }) });
 };
 export {
-  h as default
+  g as default
 };
 //# sourceMappingURL=index.js.map

package/es/FormItem/compoments/formCheckboxGroup/index.d.ts

@@ -1,8 +1,8 @@
 import { FC } from 'react';
 import { CheckboxGroupProps } from '../../../CheckboxGroup';
 export interface FormCheckboxGroupProps extends CheckboxGroupProps {
-    defaultValue?: any[];
-    change?: (value: any) => any;
+    defaultValue?: (string | number)[];
+    change?: (value: unknown) => unknown;
 }
 declare const FormCheckboxGroup: FC<FormCheckboxGroupProps>;
 export default FormCheckboxGroup;

package/es/FormItem/compoments/formFile/index.js

@@ -9,12 +9,12 @@ import y from "../../../GlobalContext/useFormatMessage.js";
 import C from "../../lang/index.js";
 import './index.css';/* empty css           */
 const B = (m) => {
-  const { fileType: o = "", defaultValue: t, onChange: p, disabled: l, buttonLabel: u, inputProps: d, buttonProps: x } = m, j = y("FormItem", C), s = c.useRef(null), h = () => {
-    s.current?.click();
+  const { fileType: o = "", defaultValue: t, onChange: p, disabled: l, buttonLabel: u, inputProps: d, buttonProps: x } = m, j = y("FormItem", C), i = c.useRef(null), h = () => {
+    i.current?.click();
   }, f = (r) => {
-    const a = r !== void 0 ? r : s.current.files;
-    n(a), p && p(a), r === null && (s.current.value = null);
-  }, [i, n] = c.useState();
+    const a = r !== void 0 ? r : i.current?.files ?? null;
+    n(a), p && p(a), r === null && i.current && (i.current.value = "");
+  }, [s, n] = c.useState();
   return c.useEffect(() => {
     t && n(t);
   }, [t]), /* @__PURE__ */ e.jsxs("div", { className: "form-file", children: [
@@ -32,16 +32,16 @@ const B = (m) => {
       "input",
       {
         ...d,
-        ref: s,
+        ref: i,
         type: "file",
         onInput: () => f(),
         hidden: !0,
         accept: typeof o == "string" ? o : o.join(",")
       }
     ),
-    i && i[0] && /* @__PURE__ */ e.jsx("div", { className: `file-tips ${l && "file-tips-disabled" || ""}`, children: /* @__PURE__ */ e.jsxs("div", { className: "file-tips-item", children: [
+    s && s[0] && /* @__PURE__ */ e.jsx("div", { className: `file-tips ${l && "file-tips-disabled" || ""}`, children: /* @__PURE__ */ e.jsxs("div", { className: "file-tips-item", children: [
       /* @__PURE__ */ e.jsx(g, {}),
-      /* @__PURE__ */ e.jsx("span", { className: "file-tips-context", children: /* @__PURE__ */ e.jsx(b, { children: typeof i == "string" ? i : i[0].name }) }),
+      /* @__PURE__ */ e.jsx("span", { className: "file-tips-context", children: /* @__PURE__ */ e.jsx(b, { children: typeof s == "string" ? s : s[0].name }) }),
       !l && /* @__PURE__ */ e.jsx(F, { onClick: () => f(null) })
     ] }) })
   ] });

package/es/FormItem/compoments/formRadioGroup/index.d.ts

@@ -2,7 +2,7 @@ import { FC } from 'react';
 import { RadioGroupProps } from '../../../RadioGroup';
 export interface FormRadioGroupProps extends RadioGroupProps {
     defaultValue?: string;
-    change?: (value: any) => any;
+    change?: (value: unknown) => unknown;
 }
 declare const FormRadioGroup: FC<FormRadioGroupProps>;
 export default FormRadioGroup;

package/es/FormItem/compoments/formSelect/index.d.ts

@@ -8,7 +8,7 @@ export type FormSelectProps = Omit<SelectProps, 'value' | 'defaultValue' | 'onCh
     /**
      * 改变方法
      */
-    change?: (value: any) => any;
+    change?: (value: unknown) => unknown;
     /**
      * 绑定值
      */

package/es/FormItem/component.json

@@ -0,0 +1,171 @@
+{
+    "name": "FormItem",
+    "category": "Data Entry",
+    "description": "表单项,通常作 FieldForm 子组件使用,形成\"校验/收集值/提交\"链路。可独立用但脱离 FieldForm 时不会自动校验。需 FormItem 自渲染控件请用 InputType prop。",
+    "semantic": {
+        "intent": [
+            "字段包装",
+            "表单控制"
+        ],
+        "useCases": [
+            "表单字段",
+            "校验绑定",
+            "布局控制"
+        ],
+        "riskLevel": "low"
+    },
+    "variants": {
+        "default": {
+            "meaning": "默认样式"
+        }
+    },
+    "states": [
+        "default",
+        "error",
+        "validating"
+    ],
+    "idealProps": {
+        "name": {
+            "type": "string",
+            "description": "字段名（**仅 string，不支持 array 路径写法**）。需在 Form/FieldForm 上下文中保持唯一；不要传 `['user','address','city']`——会触发 TS2322。\n\n**字符串点路径协议**：`name` 可以写成 `'user.address.city'` 形式（TS 合法，不报错），但 FormItem 和 Form 均**不解析点路径**——表单聚合值是 `{ 'user.address.city': value }`（扁平 key，含字面量点），而**不是** `{ user: { address: { city: value } } }`（深度嵌套对象）。点路径字段可以正常传值、校验、回填，仅聚合 key 保持原字符串。这与 antd / rc-field-form 的 `name=['a','b','c']` 深度路径解析行为**不同**——本组件不做路径解析，只做 key 直传。若业务提交需要深度嵌套对象，在提交前自行将扁平结果转换（如 `{ 'user.address.city': 'Beijing' }` → `{ user: { address: { city: 'Beijing' } } }`），或改用 `FieldForm.Item`（支持 `name={['user','address','city']}` 数组路径）。"
+        },
+        "label": {
+            "type": "string | (props: FormItemProps) => ReactNode",
+            "description": "标签文案；可传字符串或函数式渲染。**不支持 null**——传 label={null} 会触发 TS2322。要『无 label』请使用 hideLabel。"
+        },
+        "hideLabel": {
+            "type": "boolean",
+            "default": false,
+            "description": "隐藏 label 区块（连同 label 占位一起去掉）。这是『无 label 字段』的正确写法。"
+        },
+        "rules": {
+            "type": "ruleType",
+            "description": "校验规则。**这是单个对象不是数组**（与 antd 的 rules: Rule[] 不同）。结构为 `{ validate: { required, maxlength, minLength, pattern, min, max, disOnlySpace, [自定义key]: fn }, message?: { required: '...', pattern: '...' } }`。 message 与 validate 中的 key 一一对应。校验函数签名 `(item, val, intl) => true | string`：返回 true 表示通过、返回字符串表示报错文案。**⚠️ 重要：脱离 FieldForm 独立使用时，rules 不会自动触发校验**——rules 仅渲染必填红星等视觉提示，required/pattern 等不会在 children 失焦/变更时执行；完整校验链路必须配合 FieldForm 上下文。"
+        },
+        "InputType": {
+            "type": "'default' | 'select' | 'switch' | 'textarea' | 'number' | 'file' | 'radioGroup' | 'checkGroup' | 'comboSelect' | ReactNode | FC",
+            "description": "FormItem 自动渲染输入控件的类型；不传 children 时按此类型渲染对应 paraui 组件。传 children 时 InputType 不生效（外部受控）。"
+        },
+        "inputProps": {
+            "type": "Record<string, any>",
+            "description": "InputType 渲染的内部控件透传 props（如 placeholder、options 等）。"
+        },
+        "type": {
+            "type": "'horizontal' | 'vertical'",
+            "values": [
+                "horizontal",
+                "vertical"
+            ],
+            "default": "'horizontal'",
+            "description": "label 与表单项的横纵布局。"
+        },
+        "labelWidth": {
+            "type": "number",
+            "description": "label 区块宽度（仅 type='vertical' 时生效）。"
+        },
+        "tips": {
+            "type": "string",
+            "description": "label 旁的 tooltip 提示文案。"
+        },
+        "hideError": {
+            "type": "boolean",
+            "default": false,
+            "description": "隐藏校验错误提示（不影响校验逻辑本身）。"
+        },
+        "defaultValue": {
+            "type": "any",
+            "description": "默认值。会被 FieldForm 的回填数据 backData 覆盖。"
+        },
+        "disabled": {
+            "type": "boolean",
+            "description": "InputType 渲染的控件是否禁用（仅自动渲染场景生效）。"
+        },
+        "change": {
+            "type": "(value: any) => void",
+            "description": "值变化回调（仅 InputType 自动渲染场景由内部 ItemType 触发；外部 children 受控时不会自动触发——需自己监听）。"
+        },
+        "children": {
+            "type": "ReactNode",
+            "description": "自定义渲染输入控件——FormItem **不会自动注入 value/onChange**，使用方需自行受控。传了 children 时 InputType 自动渲染分支会被跳过。"
+        },
+        "errorMessage": {
+            "type": "string",
+            "description": "**脱离 FieldForm 独立使用时的受控错误文案（父组件接管 pattern）**。独立使用时 FormItem 不会自动触发 rules 校验——rules 仅渲染必填红星。错误文案必须由父组件主动驱动：① 父组件自行执行校验逻辑（如在 onBlur 中判断）；② 把校验结果写入 `errorMessage` prop（非空字符串 → 显示错误外壳；`''`/`null`/`undefined` → 清除错误状态）。不要同时传 `error` 或 `helperText`——独立使用场景统一用 `errorMessage`。"
+        },
+        "hide": {
+            "type": "boolean",
+            "description": "是否隐藏该表单项（src/FormItem/index.tsx:109 interface 实证）。hide=true 时 FormItem 不渲染（不占位），且 form.current.check() 和 form.current.getValidValues() 会跳过该字段。**与 CSS display:none 不同**——hide=true 时字段值不参与校验也不出现在提交结果中"
+        },
+        "className": {
+            "type": "string",
+            "description": "表单项容器自定义类名（src/FormItem/index.tsx:170 interface 实证）"
+        },
+        "itemType": {
+            "type": "'default' | 'select' | 'switch' | 'textarea' | 'number' | 'file' | 'radioGroup' | 'checkGroup' | 'comboSelect' | ReactNode | FC",
+            "description": "InputType 的别名（src/FormItem/index.tsx:74 interface 实证：itemType 与 InputType 同义，src 内部两者都检查）。**推荐用 InputType**——itemType 是历史命名，两者功能完全相同"
+        }
+    },
+    "do": [
+        "把 FormItem 作为 FieldForm 的子组件使用——形成完整的校验 + 提交链路",
+        "字段名仅传 string；嵌套字段在 FieldForm 层面用 schema 表达",
+        "校验规则用 paraui 自有 schema：`{ validate: { required: true, minLength: 8 }, message: { required: '请输入', minLength: '至少 8 位' } }`，不要传 `[{ required, message }]` 数组形式（会触发 TS2559）",
+        "无 label 字段使用 `hideLabel` 而不是 `label={null}`",
+        "需要自定义控件时把控件放在 children；需要自动渲染时用 InputType + inputProps",
+        "脱离 FieldForm 独立使用时:由父组件管理 children 的 value/onChange + 在父组件主动调用业务校验函数,把校验结果写入 FormItem 的 `errorMessage` prop 受控显示"
+    ],
+    "dont": [
+        "不要嵌套 FormItem",
+        "不要传 `name={['user', 'address', 'city']}`——name 仅 string",
+        "不要传 `label={null}`——会触发 TS2322；要无 label 用 `hideLabel`",
+        "不要按 antd 风格写 `rules={[{ required: true, message: '...' }]}`——会触发 TS2559；本组件 rules 是单对象 ruleType",
+        "不要假设 FormItem 自动给 children cloneElement 注入 value/onChange——本组件不做注入",
+        "不要期望 FormItem 在脱离 FieldForm 时自动触发 rules.validate.required 等校验——独立模式下 rules 仅作类型描述,业务校验需父组件主动驱动"
+    ],
+    "events": {
+        "change": {
+            "signature": "(value: any) => void",
+            "asyncSupported": false,
+            "examples": [
+                "change={(val) => setValue(val)} — 仅 InputType 自动渲染场景由内部 ItemType 触发；外部 children 受控时不会自动触发",
+                "InputType='select' 时 change 在用户选中选项时触发，value 为选中项的 value 字段值",
+                "InputType='switch' 时 change 在用户 toggle 时触发，value 为布尔值 true/false"
+            ],
+            "commonMistakes": [
+                "传了 children 还期望 change 自动触发——children 受控时 ItemType 不渲染，change 永不触发，需在 children 中自己监听",
+                "假设 change 签名与 onChange 相同是 (e) => void 原生事件——实际签名是 (value: any) => void，直接是值而非 event",
+                "脱离 FieldForm 独立使用时期望 change 携带字段名——change 只传 value，字段名需父组件通过 name 自行关联"
+            ]
+        }
+    },
+    "typescriptPitfalls": [
+        {
+            "issue": "FormItem.name 只接受 string，不能传数组路径",
+            "wrong": "const fieldName: string[] = ['user', 'address']; <FormItem name={fieldName} /> // TS2322 string[] 不能赋给 string",
+            "right": "<FormItem name='user.address' /> // 点路径字符串是合法的 string，但不会被解析为嵌套对象，聚合 key 保持原字符串形态"
+        },
+        {
+            "issue": "rules 是单对象不是数组——antd 风格写法 rules={[{required}]} 触发 TS2559",
+            "wrong": "<FormItem name='email' rules={[{ required: true, message: '必填' }]} /> // TS2559: Type '...[]' has no properties in common with ruleType",
+            "right": "<FormItem name='email' rules={{ validate: { required: true }, message: { required: '必填' } }} />"
+        },
+        {
+            "issue": "label 不支持传 null，要无 label 应用 hideLabel",
+            "wrong": "<FormItem name='code' label={null} /> // TS2322: Type 'null' is not assignable to 'string | (props: FormItemProps) => ReactNode'",
+            "right": "<FormItem name='code' hideLabel /> // 正确隐藏 label 区块"
+        },
+        {
+            "issue": "InputType 和 itemType 同时存在时，src 优先取 InputType（itemType 是别名）",
+            "wrong": "// 同时传两个不同值，期望 itemType 生效\n<FormItem name='x' itemType='select' InputType='default' /> // InputType 优先，select 不生效",
+            "right": "// 统一用 InputType，itemType 是历史别名\n<FormItem name='x' InputType='select' />"
+        },
+        {
+            "issue": "select 子项的 list 字段用 value，radioGroup/checkGroup 用 name——混用导致选中后 change 不传值",
+            "wrong": "InputType='select' list={[{label: 'A', name: 'a'}]} // select 读 value 字段，name 被忽略",
+            "right": "InputType='select' list={[{label: 'A', value: 'a'}]} // 而 radioGroup/checkGroup 用 name 字段"
+        }
+    ],
+    "mapping": {
+        "realComponent": "FormItem",
+        "adapter": null
+    }
+}