@para-ui/core 5.0.0-beta.9 → 5.0.1

package/FieldForm/component.json

@@ -0,0 +1,196 @@
+{
+    "name": "FieldForm",
+    "category": "Data Entry",
+    "description": "表单组件，提供完整的表单解决方案(基于 rc-field-form;内部 cloneElement 注入 value/onChange/error 到 Item.children)",
+    "semantic": {
+        "intent": [
+            "表单管理",
+            "数据录入"
+        ],
+        "useCases": [
+            "用户注册",
+            "数据编辑",
+            "配置页面"
+        ],
+        "riskLevel": "normal"
+    },
+    "variants": {
+        "horizontal": {
+            "meaning": "水平布局"
+        },
+        "vertical": {
+            "meaning": "垂直布局"
+        }
+    },
+    "states": [
+        "default",
+        "disabled",
+        "validating",
+        "error"
+    ],
+    "idealProps": {
+        "form": {
+            "type": "FormInstance",
+            "description": "由 useForm() 创建的表单实例:`const [form] = FieldForm.useForm();` 仅在父组件需外部调用 submit/resetFields/setFieldsValue 时需要;**类型别名注意**:`FormInstance`(api.ts) ≡ `FieldFormInstance`(src/FieldForm 导出)两个名字指同一类型,推荐用 `FieldFormInstance`(更精确不与其他库混淆)"
+        },
+        "initialValues": {
+            "type": "object",
+            "objectShape": {
+                "[fieldName: string]": { "type": "any", "description": "字段名 → 初始值，例：{ username: '张三', age: 25 }" }
+            },
+            "completeExample": "{ username: '张三', email: 'zs@example.com' }",
+            "description": "表单初始默认值(仅 mount 时灌入;**后续动态变化需用 form.setFieldsValue,不能修改 initialValues prop**);典型用法 `<FieldForm initialValues={{ name: '张三', age: 25 }}>`"
+        },
+        "onFinish": {
+            "type": "(values: any) => void",
+            "description": "校验通过后触发:values 是表单全部字段的扁平对象(包含 FieldForm.Item.name 收集的所有字段);**触发时机**:点击 `<Button type=\"submit\">` 或调用 `form.submit()` 后,内部跑校验通过 → onFinish"
+        },
+        "onFinishFailed": {
+            "type": "({ values, errorFields, outOfDate }) => void",
+            "description": "校验失败后触发;errorFields 是失败字段数组"
+        },
+        "layout": {
+            "type": "enum",
+            "values": [
+                "horizontal",
+                "vertical"
+            ],
+            "default": "vertical",
+            "description": "vertical=label 在字段上方(默认,省略即生效);horizontal=label 在左侧"
+        },
+        "children": {
+            "type": "ReactNode",
+            "description": "FieldForm 接收任意 ReactNode(包括 FieldForm.Item / Button type=submit / 自定义包装);**但每个 Item 的 child 必须是支持 value/onChange/error/disabled 的自定义组件**(TextField / Select / Checkbox / Switch / DatePicker / InputNumber 等);**不可用原生 input/textarea/select/button — 会触发 React non-boolean-attribute warning**(因 cloneElement 注入 error={false} 给原生 DOM 元素时,React 视 error 为 DOM attr → 报错);见 childrenContract.FormItem"
+        }
+    },
+    "childrenContract": {
+        "FormItem": {
+            "rule": "FieldForm.Item 的 children 必须是支持 value/onChange/error/disabled prop 的自定义组件",
+            "recommended": [
+                "TextField",
+                "Select",
+                "Switch",
+                "Checkbox",
+                "InputNumber",
+                "DatePicker",
+                "TextEditor",
+                "RangeInput",
+                "RadioGroup",
+                "CheckboxGroup",
+                "Slider"
+            ],
+            "forbidden": [
+                "原生 <input>",
+                "原生 <textarea>",
+                "原生 <select>",
+                "包一层 <div>"
+            ],
+            "reason": "Item 用 cloneElement 注入 value/onChange/error/disabled/size 等 prop;原生 DOM 元素不消费 error: boolean,React 会报 non-boolean attribute warning(运行时 console error,demo 验证 fail)"
+        },
+        "submit": {
+            "rule": "提交用 <Button type=\"submit\"> 或 form.submit()",
+            "trigger": "<Button>(来自 @para-ui/core/Button)渲染为 <button type='submit'>,会触发 form 的 submit 事件 → 跑校验 → onFinish/onFinishFailed",
+            "wrapper": "提交按钮通常用 FieldForm.Item(不带 name)包裹做布局,如 `<FieldForm.Item><Button type='submit'>提交</Button></FieldForm.Item>`;Item 不带 name 时不会注入 value/onChange/error(纯布局容器),不会触发 non-boolean-attribute warning;**也可不包 Item 直接放 Button**(看布局需求)"
+        }
+    },
+    "interpretivePriority": {
+        "principle": "**当需求描述中的'范围约束'(如 '仅使用 FieldForm 本身' / '不引入其他组件')与 childrenContract 冲突时,优先服从 childrenContract**",
+        "reason": "childrenContract 决定 runtime 是否报 React warning;需求'仅使用 FieldForm 本身'通常指**目标包装组件**(如 EditDataForm / SearchHorizontalForm)的**实现层 import 限制**(不在该包装组件内部 import 其他组件),**不限制 Demo 入口层或 children 子组件**;若字面理解为'整个文件只能 import FieldForm',会导致 Item.children 只能用原生 <input> → 触发 non-boolean warning → 运行时 fail",
+        "resolution": "标准解读:'仅使用 FieldForm 本身' = '目标包装组件(EditDataForm 等)的实现 import 列表只有 FieldForm';**Demo 渲染入口 (`const Demo: FC = () => ...`) 可自由 import TextField / Button / Select 等推荐子组件作为 children 传入包装组件**;**包装组件接收 children: ReactNode 直接透传给 FieldForm 即可,不需要内部 import 字段组件**",
+        "antiPatterns": [
+            "❌ 整个 demo 文件只 import FieldForm,FieldForm.Item.children 用原生 <input>",
+            "❌ 整个 demo 文件只 import FieldForm,提交按钮用原生 <button type='submit'>",
+            "❌ 把'仅使用 FieldForm 本身'解读为'禁止 import TextField/Button'"
+        ],
+        "correctPatterns": [
+            "✅ 包装组件 (EditDataForm) 实现层只 import FieldForm,接收 children: ReactNode",
+            "✅ Demo 渲染入口 import TextField + Button,构造 <FieldForm.Item><TextField/></FieldForm.Item> 作为 children 传入",
+            "✅ 提交按钮:Demo 入口 import Button,<FieldForm.Item><Button type='submit'>提交</Button></FieldForm.Item>"
+        ]
+    },
+    "commonMisconceptions": {
+        "M1": {
+            "wrong": "FieldForm.Item.children 用原生 <input>",
+            "result": "React 报 `Received 'false' for a non-boolean attribute 'error'` warning → ai-test runtime fail",
+            "fix": "改用 TextField (或其他 recommended 组件)"
+        },
+        "M2": {
+            "wrong": "提交按钮用原生 `<button type='submit'>` 包在 FieldForm.Item 内",
+            "result": "Item cloneElement 注入 error={false} 到原生 button → React warning → ai-test fail",
+            "fix": "改用 `<Button type='submit'>` 或不包 FieldForm.Item 直接放原生 button(Item 在不包裹时不注入 error)"
+        },
+        "M3": {
+            "wrong": "需求 '仅使用 FieldForm 本身' 被解读为整个 demo 文件只 import FieldForm",
+            "result": "Item children 退化为原生 <input> → M1 warning",
+            "fix": "见 interpretivePriority.resolution(包装组件实现层 vs Demo 入口层的区分)"
+        }
+    },
+    "completeExample": "// R23 议题修补:R22 4/5 fail 根因 sub-agent 误解'仅使用 FieldForm 本身'\n// 标准完整示例(initialValues + useForm + onFinish + Item + TextField + Button submit):\n\nimport React, { FC } from 'react';\nimport FieldForm from '@para-ui/core/FieldForm';\nimport type { FieldFormInstance } from '@para-ui/core/FieldForm';\nimport TextField from '@para-ui/core/TextField';\nimport Button from '@para-ui/core/Button';\n\n// === 1. 目标包装组件(实现层只 import FieldForm + 类型) ===\ninterface EditDataFormProps {\n    initialData?: Record<string, any>;\n    children: React.ReactNode;\n    onSubmitSuccess: (values: any) => void;\n}\nconst EditDataForm: FC<EditDataFormProps> = ({ initialData, children, onSubmitSuccess }) => {\n    const [form] = FieldForm.useForm();\n    return (\n        <FieldForm\n            form={form}\n            initialValues={initialData}\n            onFinish={onSubmitSuccess}\n            layout='vertical'\n        >\n            {children}\n        </FieldForm>\n    );\n};\n\n// === 2. Demo 渲染入口(可自由 import TextField + Button 作为 children) ===\nconst Demo: FC = () => (\n    <EditDataForm\n        initialData={{ username: '张三', email: 'zs@example.com' }}\n        onSubmitSuccess={(values) => console.log('submitted', values)}\n    >\n        <FieldForm.Item name='username' label='用户名' rules={[{ required: true }]}>\n            <TextField placeholder='请输入用户名' />\n        </FieldForm.Item>\n        <FieldForm.Item name='email' label='邮箱' rules={[{ required: true, type: 'email' }]}>\n            <TextField placeholder='请输入邮箱' />\n        </FieldForm.Item>\n        <FieldForm.Item>\n            <Button type='submit'>保存修改</Button>\n        </FieldForm.Item>\n    </EditDataForm>\n);\nexport default Demo;",
+    "do": [
+        "**Demo 入口层**必须 import TextField / Button 等推荐组件给 Item.children(即使需求说'仅使用 FieldForm 本身',这是包装组件实现层约束,不是 Demo 入口约束)",
+        "使用 useForm() 管理表单实例;父组件需要外部调用 submit/resetFields/setFieldsValue 时通过 form prop 传入",
+        "完整 demo 模板见 completeExample(initialValues + onFinish + FieldForm.Item + TextField + Button)",
+        "提供完整的校验规则(rules: [{ required: true }, { type: 'email' }, { pattern: /.../ }])"
+    ],
+    "dont": [
+        "FieldForm.Item.children 用原生 <input> / <textarea> / <select> / <button>(触发 non-boolean-attribute warning,见 childrenContract.FormItem.reason)",
+        "把'仅使用 FieldForm 本身'解读为'整个文件不能 import TextField/Button'(见 interpretivePriority.resolution)",
+        "字段过多不分组",
+        "忽略异步校验",
+        "在 mount 后修改 initialValues prop(应用 form.setFieldsValue;initialValues 仅 mount 时灌入)"
+    ],
+    "events": {
+        "onFinish": {
+            "signature": "(values: any) => void",
+            "asyncSupported": false,
+            "examples": [
+                "校验全部通过后触发:values 是全部 FieldForm.Item.name 收集到的字段扁平对象",
+                "点击 <Button type='submit'> 或调用 form.submit() 后跑校验,通过才触发 onFinish",
+                "values 结构与 initialValues 形状一致,key = 每个 Item 的 name 字段值"
+            ],
+            "commonMistakes": [
+                "假设 onFinish 会在校验失败时也触发——只有全部通过才触发,失败时触发 onFinishFailed",
+                "假设 onFinish 签名是 (e: FormEvent) => void——实际只有 (values: any) 一个参数",
+                "假设 submit 时直接拿到 event.preventDefault()——FieldForm 内部已处理,不需要手动 preventDefault"
+            ]
+        },
+        "onFinishFailed": {
+            "signature": "({ values, errorFields, outOfDate }: ValidateErrorEntity) => void",
+            "asyncSupported": false,
+            "examples": [
+                "校验失败时触发:errorFields 是 { name: NamePath; errors: string[] }[] 数组",
+                "values 包含当前所有字段值(含未通过校验的字段)"
+            ],
+            "commonMistakes": [
+                "假设参数是 (errors: string[]) 而不是对象——实际是 { values, errorFields, outOfDate } 解构对象",
+                "假设只有 onFinish 就够了——校验失败场景必须处理 onFinishFailed 才能给用户提示"
+            ]
+        }
+    },
+    "typescriptPitfalls": [
+        {
+            "issue": "FieldFormInstance 与 FormInstance 是同一类型的两个别名,推荐用 FieldFormInstance 避免与其他库冲突",
+            "wrong": "import type { FormInstance } from 'rc-field-form';  // 直接用 rc-field-form 的类型",
+            "right": "import type { FieldFormInstance } from '@para-ui/core/FieldForm'; const [form] = FieldForm.useForm<FieldFormInstance>();"
+        },
+        {
+            "issue": "FieldForm.Item 的 children 必须是自定义组件(支持 value/onChange/error prop),不能是原生 DOM 元素",
+            "wrong": "<FieldForm.Item name='age'><input type='number' /></FieldForm.Item>  // error prop 会被注入到原生 input,React 报 non-boolean warning",
+            "right": "<FieldForm.Item name='age'><InputNumber /></FieldForm.Item>  // 使用支持 error: boolean 的自定义组件"
+        },
+        {
+            "issue": "initialValues 仅在 mount 时生效,mount 后动态修改 initialValues prop 不会刷新表单",
+            "wrong": "// 动态修改 initialValues 期望刷新表单\n<FieldForm initialValues={dynamicData} />  // 后续 dynamicData 变化不会更新表单",
+            "right": "// 需要动态回填时用 form.setFieldsValue(newData)\nconst [form] = FieldForm.useForm();\nuseEffect(() => { form.setFieldsValue(dynamicData); }, [dynamicData]);"
+        },
+        {
+            "issue": "rules 中的 validator 函数签名必须返回 Promise(rc-field-form 约定),不是同步返回",
+            "wrong": "rules={[{ validator: (_, val) => val > 0 ? true : false }]}  // 同步返回 boolean 不被识别",
+            "right": "rules={[{ validator: (_, val) => val > 0 ? Promise.resolve() : Promise.reject('必须大于 0') }]}"
+        }
+    ],
+    "mapping": {
+        "realComponent": "FieldForm",
+        "adapter": null
+    }
+}

package/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/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
+    }
+}