@qin-ui/antd-vue-pro 2.1.14 → 2.2.0

package/AI-CONTEXT.md

@@ -1,123 +1,236 @@
-# @qin-ui/antd-vue-pro
+# @qin-ui/antd-vue-pro — AI Context
 
-> 基于 ant-design-vue v4 的配置驱动表单和表格组件库。
+> Schema-driven component library wrapping **ant-design-vue v4** (`a-` prefix). Describe UIs as JS objects instead of template tag soup.
 
-## 安装
+---
+
+## 1. Architecture
+
+### 1.1 Three-layer rendering
 
-```bash
-npm install @qin-ui/antd-vue-pro ant-design-vue vue
 ```
+Field[] config layer       { path:'name', component:'input', span:8, label:'Name', placeholder:'...' }
+        │
+@qin-ui/antd-vue-pro       Schema parser — strips props layer by layer
+        │
+ant-design-vue v4          a-input / a-select / a-table / a-form-item / a-col  ...
+```
+
+ProForm/ProTable are **rendering engines**, not a component library. All actual UI comes from ant-design-vue. Field props are peeled off and dispatched to different DOM layers.
+
+### 1.2 Component resolution
+
+`Field.component` string → `componentMap` → ant-design-vue component.
+
+If not found in the built-in map, the string is resolved against `ProComponentProvider` injected components; a Vue component object is rendered directly (used by `'custom'` internally).
 
-## 快速开始
+### 1.3 Built-in component map
 
-```typescript
-import { ProForm, ProTable } from '@qin-ui/antd-vue-pro';
-import { useForm, useTable } from '@qin-ui/antd-vue-pro';
+| Field `component`  | ant-design-vue component | Key pass-through props (verify against https://antdv.com)                              |
+| :----------------- | :----------------------- | :------------------------------------------------------------------------------------- |
+| `'input'`          | Input                    | placeholder, maxlength, allowClear, addonBefore, addonAfter, prefix, suffix, showCount |
+| `'textarea'`       | TextArea                 | rows, maxlength, showCount, autoSize                                                   |
+| `'input-password'` | InputPassword            | placeholder, maxlength, visibilityToggle                                               |
+| `'input-search'`   | InputSearch              | placeholder, loading, onSearch                                                         |
+| `'input-number'`   | InputNumber              | min, max, step, precision, formatter, parser                                           |
+| `'select'`         | Select                   | **options**, mode, showSearch, filterOption, allowClear, loading                       |
+| `'cascader'`       | Cascader                 | **options**, fieldNames, showSearch, allowClear                                        |
+| `'date-picker'`    | DatePicker               | picker, format, showTime, disabledDate, valueFormat                                    |
+| `'range-picker'`   | RangePicker              | format, showTime, disabledDate, allowClear                                             |
+| `'time-picker'`    | TimePicker               | format, showSecond, hourStep, minuteStep                                               |
+| `'checkbox-group'` | CheckboxGroup            | **options**, direction                                                                 |
+| `'radio-group'`    | RadioGroup               | **options**, direction, buttonStyle                                                    |
+| `'switch'`         | Switch                   | checkedChildren, unCheckedChildren, loading                                            |
+| `'slider'`         | Slider                   | min, max, step, marks, range, tooltip                                                  |
+| `'tree-select'`    | TreeSelect               | **treeData**, showSearch, treeCheckable, fieldNames                                    |
+| `'transfer'`       | Transfer                 | **dataSource**, **titles**, **targetKeys**, showSearch, render                         |
+| `'custom'`         | (user-supplied)          | component receives a Vue component or `h()` render function                            |
+
+> The prop column is illustrative. **Always verify prop names/types against [antdv.com](https://antdv.com).**
+
+---
+
+## 2. Property layering (core rule)
+
+Field props are **stripped in layers** and dispatched to different DOM targets.
+
+```
+<a-col :span="8">                   ← Grid layer
+  <a-form-item label="City">        ← FormItem layer
+    <a-select placeholder="..." />  ← Input-control layer
+  </a-form-item>
+</a-col>
 ```
 
-## 核心导出
+### 2.1 Layer dispatch
 
-### 组件
+**Grid layer → `<a-col>`** (only when grid is enabled):
+`span`, `order`, `offset`, `push`, `pull`, `flex`, `xs`, `sm`, `md`, `lg`, `xl`, `xxl`
 
-| 组件名                 | 描述             |
-| ---------------------- | ---------------- |
-| `ProForm`              | 配置驱动表单组件 |
-| `ProTable`             | 配置驱动表格组件 |
-| `ProComponentProvider` | 全局配置提供者   |
+**FormItem layer → `<a-form-item>`**:
+`label`, `rules`, `colon`, `labelAlign`, `labelCol`, `wrapperCol`, `tooltip`, `extra`, `help`, `validateFirst`, `validateTrigger`, `valuePropName`, `normalize`, `formItemClass`→`class`, `formItemStyle`→`style`, `formItemContainer`, `formItemDataAttrs`→`data-*`
 
-### Hooks
+**Input-control layer → the input component** (everything else):
+`disabled`, `placeholder`, `allowClear`, `options`, `showSearch`, `maxlength`, `mode`, `componentClass`→`class`, `componentStyle`→`style`, `componentDataAttrs`→`data-*`, and any ant-design-vue props for that component.
 
-| Hook               | 描述         |
-| ------------------ | ------------ |
-| `useForm<D>()`     | 创建表单实例 |
-| `useFields<D>()`   | 字段配置管理 |
-| `useFormRef()`     | 表单组件引用 |
-| `useTable<D, T>()` | 创建表格实例 |
+**Consumed by ProForm logic, not bound to DOM**: `component`, `fields`, `hidden`, `slots`, `modelProp`, `valueFormatter`, `componentContainer`, `extraProps`.
 
-## ProForm 使用
+### 2.2 modelProp
 
-```vue
-<template>
-  <ProForm :form="form" @submit="onSubmit">
-    <template #name="{ value }">
-      <a-input :value="value" />
-    </template>
-  </ProForm>
-</template>
-
-<script setup lang="ts">
-interface User {
-  name: string;
-  age: number;
-}
-
-const form = useForm<User>({ name: '张三' }, [
-  { path: 'name', label: '姓名', component: 'input' },
-  { path: 'age', label: '年龄', component: 'input-number' },
+Controls the `v-model:xxx` binding name.
+
+- Default: `modelProp: 'value'` → `v-model:value`
+- Switch uses `checked` — **ProComponentProvider presets `modelProp: 'checked'` for `'switch'`** so you rarely set it manually.
+- Override per-field when using a custom component that expects a different v-model prop.
+
+---
+
+## 3. Progressive usage
+
+### Level 1: Config-driven (no hand-written a-\* tags)
+
+```ts
+import { ProForm, useForm } from '@qin-ui/antd-vue-pro';
+
+const form = useForm({ username: '', password: '' }, [
+  {
+    path: 'username',
+    component: 'input',
+    label: '用户名',
+    placeholder: '请输入',
+    rules: [{ required: true }],
+  },
+  {
+    path: 'password',
+    component: 'input-password',
+    label: '密码',
+    placeholder: '请输入',
+    rules: [{ required: true }],
+  },
 ]);
-</script>
 ```
 
-## ProTable 使用
+```html
+<ProForm :form="form" />
+```
+
+### Level 2: Field linkage
+
+Control props (`disabled`, `hidden`, `rules`, etc.) support three reactivity patterns:
+
+```ts
+// A) computed() — declarative, for linkages known at init (preferred)
+disabled: computed(() => !form.formData.enabled),
+rules: computed(() => [{ required: form.formData.hasLimit, message: '必填' }]),
+
+// B) ref() — external shared state
+const isDisabled = ref(false);
+
+// C) setField() — imperative, for event-driven changes
+form.setField('limitCount', { disabled: true });
+```
+
+**Rule: pick the simplest. computed() for init-time, setField() for runtime events, ref() for external state.**
+
+### Level 3: Custom component
+
+```ts
+import { h } from 'vue';
+import CustomInput from './CustomInput.vue';
+
+// In field config:
+{ path: 'key', component: (p, ctx) => h(CustomInput, { ...p, ...ctx.attrs }) }
+```
+
+Or via scoped slot in template (all binding params forwarded via `v-bind="scoped"`):
+
+```html
+<ProForm :form="form">
+  <template #agreement="scoped">
+    <a-checkbox v-bind="scoped">同意协议</a-checkbox>
+  </template>
+</ProForm>
+```
+
+---
+
+## 4. Anti-patterns
+
+- **Never hand-write `<a-form-item>` inside `<ProForm>`.** ProForm renders FormItems from Field config automatically.
+- **Never guess pass-through prop names.** Verify against [ant-design-vue docs](https://antdv.com).
+- **Don't confuse Grid props with input props.** `span` goes to `<a-col>`, not the input.
+- **Use `computed()` for reactive Field configs.** Plain values won't track dependencies.
+- **Prefer the simplest linkage pattern.** Don't use `setField()` when `computed()` suffices.
+
+---
+
+## 5. ProComponentProvider — global defaults
+
+Wrap your app to set defaults for all ProForm/ProTable instances. Merged with priority (highest first):
+
+1. **Field-level config** (always wins)
+2. **`componentVars`** passed to ProComponentProvider
+3. **`INJECT_CONFIG`** built-in presets
+
+### Built-in presets (INJECT_CONFIG)
+
+| Component                                      | Preset                                                                                                                                  |
+| :--------------------------------------------- | :-------------------------------------------------------------------------------------------------------------------------------------- |
+| `switch`                                       | `{ modelProp: 'checked' }`                                                                                                              |
+| `input`                                        | `{ maxlength: 100, allowClear: true, placeholder: '请输入' }`                                                                           |
+| `textarea`                                     | `{ maxlength: 200, autoSize: {minRows:3,maxRows:6}, showCount: true, allowClear: true, placeholder: '请输入' }`                         |
+| `select` / `cascader`                          | `{ allowClear: true, placeholder: '请选择', getPopupContainer }`                                                                        |
+| `input-number`                                 | `{ max: 10^15, min: -(10^15), controls: false, placeholder: '请输入', style: {width:'100%'} }`                                          |
+| `date-picker` / `range-picker` / `time-picker` | `{ allowClear: true, getPopupContainer, style: {width:'100%'} }`                                                                        |
+| `pro-table`                                    | `{ pagination: {showTotal, showSizeChanger, showQuickJumper}, searchFormConfig: {layout:'grid'}, control: true, addIndexColumn: true }` |
+| `pro-form`                                     | `{ grid: { gutter: {xs:8, sm:16, md:16, lg:24} } }`                                                                                     |
+| `pro-form-item`                                | `{ validateFirst: true, span: 8 }`                                                                                                      |
+
+### Override example
 
 ```vue
-<template>
+<ProComponentProvider
+  :component-vars="{
+    'pro-form-item': { span: 6 },
+    input: { maxlength: 200 },
+    select: { showSearch: true },
+    'pro-table': { addIndexColumn: false },
+  }"
+>
+  <ProForm :form="form" />
   <ProTable :table="table" />
-</template>
+</ProComponentProvider>
+```
 
-<script setup lang="ts">
-interface User {
-  name: string;
-  age: number;
-}
+---
 
-const table = useTable({
+## 6. ProTable quick reference
+
+```ts
+import { ProTable, useTable } from '@qin-ui/antd-vue-pro';
+
+const table = useTable<Row>({
   columns: [
-    { dataIndex: 'name', title: '姓名' },
-    { dataIndex: 'age', title: '年龄' },
+    { title: 'ID', dataIndex: 'id', width: 80 },
+    { title: 'Name', dataIndex: 'name', width: 120 },
+  ],
+  // searchFields uses the same Field[] format as ProForm
+  searchFields: [
+    { path: 'name', component: 'input', placeholder: 'Search' },
+    { path: 'status', component: 'select', options: [...] },
   ],
-  dataSource: [],
 });
-</script>
+// table.searchForm is a ProForm instance — all form methods available
 ```
 
-## 字段配置（Field）
-
-每个字段支持以下属性：
-
-- `path` - 数据路径（类型安全）
-- `label` - 字段标签
-- `component` - 组件名（内置支持: input, textarea, input-search, input-password, input-number, select, cascader, date-picker, range-picker, time-picker, checkbox-group, radio-group, switch, slider, tree-select, transfer, custom）
-- `hidden` - 是否隐藏
-- `disabled` - 是否禁用
-- `rules` - 校验规则
-- `valueFormatter` - 值格式化函数
-- `fields` - 嵌套子字段
-- `grid` - 网格布局
-- `slots` - FormItem 插槽配置
-- `componentStyle/componentClass` - 组件样式
-- `componentContainer` - 组件容器包装
-- `formItemStyle/formItemClass` - FormItem 样式
-- `formItemContainer` - FormItem 容器包装
-- `modelProp` - v-model 绑定属性名
-
-完整类型定义见 `Field<ComponentName, D>`。
-
-## 表格列配置（Column）
-
-每列支持以下属性：
-
-- `dataIndex` - 数据路径（优先使用）
-- `key` - 列标识（dataIndex 不满足时使用）
-- `hidden` - 是否隐藏
-- 所有 ant-design-vue ColumnType 属性（title, width, fixed, align 等）
-
-## 类型扩展
-
-```typescript
-declare module '@qin-ui/antd-vue-pro' {
-  interface ComponentMap {
-    'my-custom-component': typeof MyComponent;
-  }
-}
+```html
+<ProTable :table="table" :search="fetchData" addIndexColumn immediateSearch />
 ```
+
+---
+
+## 7. References
+
+1. **`node_modules/@qin-ui/antd-vue-pro/api.json`** — Structured API metadata (signatures, types, JSDoc examples)
+2. **`node_modules/@qin-ui/antd-vue-pro/README.md`** — Full usage docs and code examples
+3. **[antdv.com](https://antdv.com)** — ant-design-vue component API reference (always check before writing pass-through props)

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023-present pro-components
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/api.json

@@ -1,5 +1,5 @@
 {
-  "generatedAt": "2026-06-08T06:46:32.287Z",
+  "generatedAt": "2026-07-09T04:30:45.412Z",
   "name": "@qin-ui/antd-vue-pro",
   "api": [
     {
@@ -19,12 +19,19 @@
       "signature": "export type ComponentVars = Partial<RequiredComponentVars>;",
       "description": "组件全局配置\nRequiredComponentVars 的 Partial 版本，用于 ProComponentProvider 的 props"
     },
+    {
+      "name": "ContainerFragment",
+      "type": "component",
+      "package": "@qin-ui/antd-vue-pro",
+      "signature": "<ContainerFragment>",
+      "description": "容器分片渲染组件。用于动态渲染表单行或表单项的外部包裹容器（例如 Grid 行、Col 列等布局容器）。"
+    },
     {
       "name": "ProForm",
       "type": "component",
       "package": "@qin-ui/antd-vue-pro",
       "signature": "<ProForm>",
-      "description": "@qin-ui/antd-vue-pro 配置驱动表单组件\n通过配置驱动的方式快速构建表单，支持：\n- 字段联动（通过 setField、watch 等实现）\n- 嵌套字段（通过 fields 递归配置）\n- 自定义组件（通过 component 属性和 custom 类型）\n- 网格布局（通过 grid 属性）\n- 动态插槽（以字段 path 命名的插槽）\n- 全局配置注入（通过 ProComponentProvider）",
+      "description": "@qin-ui/antd-vue-pro 配置驱动表单组件\n架构设计说明 (Architecture Overview)\n[ 数据层 (Core) ]  =>  [ 绑定层 (ProForm) ]  =>  [ 渲染层 (BaseFormItem / BaseField) ]\n1. 数据隔离：ProForm 本身不负责存储和管理表单状态，所有核心状态（formData, fields, 校验规则）\n均交由底层的 `useForm`（@qin-ui/pro-components-core）驱动。\n2. 上下文透传：通过 `provide` 将核心状态下发给子组件，避免了深层嵌套的 Props 传递。\n3. 递归渲染：网格布局和具体字段的解析交由 `<BaseFormItem>` 递归完成，实现了 UI 布局与表单逻辑的解耦。\n通过配置驱动的方式快速构建表单，支持：\n- 字段联动（通过 setField、watch 等实现）\n- 嵌套字段（通过 fields 递归配置）\n- 自定义组件（通过 component 属性和 custom 类型）\n- 网格布局（通过 grid 属性）\n- 动态插槽（以字段 path 命名的插槽）\n- 全局配置注入（通过 ProComponentProvider）",
       "typeParams": [
         {
           "name": "F"
@@ -34,13 +41,6 @@
         "```vue\n<template>\n<ProForm :form=\"form\" :fields=\"fields\" @submit=\"handleSubmit\">\n<template #name=\"{ value, disabled }\">\n<a-input :value=\"value\" :disabled=\"disabled\" />\n</template>\n</ProForm>\n</template>\n```"
       ]
     },
-    {
-      "name": "ContainerFragment",
-      "type": "component",
-      "package": "@qin-ui/antd-vue-pro",
-      "signature": "<ContainerFragment>",
-      "description": "容器分片渲染组件。用于动态渲染表单行或表单项的外部包裹容器（例如 Grid 行、Col 列等布局容器）。"
-    },
     {
       "name": "SlotComponent",
       "type": "component",
@@ -72,9 +72,9 @@
       "name": "useFormData",
       "type": "function",
       "package": "@qin-ui/antd-vue-pro",
-      "signature": "export const useFormData = <D extends Data = Data>(\n  initFormData?: ExtendWithAny<DeepPartial<D>>\n) =>",
+      "signature": "export const useFormData = <D extends Data = Data>(\n  initFormData?: ExtendWithAny<DeepPartial<D>>\n): UseFormDataReturn<D> =>",
       "description": "表单数据处理 Hook\n提供响应式表单数据的管理能力，支持：\n- 响应式数据存储（基于 Vue reactive）\n- 深层路径读写（支持点号分隔，如 'address.city'）\n- 类型安全的路径提示（传入泛型 D 后，path 参数可获得类型推导）\n- 父子表单自动注入（非根表单会从注入中获取数据）",
-      "returns": "{Function} .setFormData(path, value) - 设置指定路径的数据",
+      "returns": "{UseFormDataReturn<D>} 表单数据操作对象",
       "typeParams": [
         {
           "name": "D"
@@ -88,15 +88,16 @@
       "name": "useFields",
       "type": "function",
       "package": "@qin-ui/antd-vue-pro",
-      "signature": "export const useFields = _useFields as",
-      "description": "类型安全的 re-export。将 core useFields 的泛型参数绑定为本地类型：\n- 字段类型 F → Field<ComponentName, D>（支持 Ant Design Vue 组件类型推导）\n- FormItem 实例 → Ant Design Vue 的 FormItemInstance\n提供对字段配置数组的增删改查操作，详见 `@qin-ui/core` 的 useFields 文档。",
+      "signature": "export function useFields<D extends Data = Data>(\n  initFields?: Fields<D>\n): UseFieldsReturn<D, Field<ComponentName, D>, FormItemInstance>;",
+      "description": "字段配置管理 Hook\n基于 `@qin-ui/pro-components-core` 的 `useFields`，将泛型参数绑定为 Ant Design Vue 的本地类型：\n- 字段类型 F -> `Field<ComponentName, D>`（支持 Ant Design Vue 组件类型推导）\n- FormItem 实例 -> Ant Design Vue 的 `FormItemInstance`\n提供对字段配置数组的增删改查操作，支持：\n- 通过路径字符串或查找函数定位字段\n- 深层嵌套字段的遍历和匹配\n- 字段配置的合并/覆盖更新\n- 字段的添加、插入、删除\n- 父级字段查找\n- `fields` - 字段配置数组（响应式 Ref\\<F[]\\>）\n- `getField(path)` - 获取字段配置，支持路径字符串或查找函数\n- `setField(path, field, options?)` - 更新字段配置，默认合并模式\n- `deleteField(path, options?)` - 删除字段配置\n- `appendField(path, field, options?)` - 在指定字段后追加\n- `prependField(path, field, options?)` - 在指定字段前插入\n- `getParentField(path, options?)` - 获取父级字段配置",
+      "returns": "字段操作对象，包含以下属性：",
       "typeParams": [
         {
           "name": "D"
         }
       ],
       "examples": [
-        "```ts\ninterface User { name: string; age: number }\n\nconst { fields, getField, setField } = useFields<User>([\n{ path: 'name', label: '姓名', component: 'input' },\n{ path: 'age', label: '年龄', component: 'input-number' },\n])\n\n// 获取字段（类型安全，包含 Ant Design Vue 组件属性）\ngetField('name') // 返回值包含 input 组件的所有可选属性\n```"
+        "```ts\ninterface User { name: string; age: number }\n\nconst { fields, getField, setField } = useFields<User>([\n{ path: 'name', label: '姓名', component: 'input' },\n{ path: 'age', label: '年龄', component: 'input-number' },\n])\n\n// 通过路径获取\ngetField('name')\n// 通过查找函数获取\ngetField(f => f.label === '姓名')\n// 更新字段（合并模式）\nsetField('name', { label: '用户名', disabled: true })\n```"
       ]
     },
     {
@@ -104,14 +105,14 @@
       "type": "type",
       "package": "@qin-ui/antd-vue-pro",
       "signature": "export type UseFields<D extends Data = Data> = ReturnType<typeof useFields<D>>;",
-      "description": "useFields 返回值类型，固定为本地 Fields<D>"
+      "description": "useFields 返回值类型"
     },
     {
       "name": "Form",
       "type": "type",
       "package": "@qin-ui/antd-vue-pro",
       "signature": "export type Form<\n  D extends Data = Data,\n  F extends Field<ComponentName, D> = Field<ComponentName, D>,\n> = _Form<D, F, FormInstance>;",
-      "description": "在 core Form 类型的基础上：\n1. 将字段类型 F 默认绑定为本地 Field<ComponentName, D>，支持 Ant Design Vue 所有内置组件类型\n2. 将底层表单实例 I 绑定为 Ant Design Vue 的 FormInstance，使 formRef 获得完整的类型提示",
+      "description": "表单实例类型\n在 core Form 类型的基础上，将字段类型 F 绑定为本地 Field<ComponentName, D>，\n将底层表单实例 I 绑定为 Ant Design Vue 的 FormInstance，使 formRef 获得完整的类型提示。\n1. `setFormData(path, value)` - 设置指定路径的值<br>\n2. `setFormData(path, prev => newVal)` - 函数式更新<br>\n3. `setFormData({ ... })` - 批量覆盖整个表单",
       "typeParams": [
         {
           "name": "D"
@@ -121,33 +122,34 @@
         }
       ],
       "examples": [
-        "```ts\ninterface User { name: string; age: number }\nconst form: Form<User> = useForm({ name: '张三', age: 25 })\nform.formRef.value?.validate() // 类型安全地访问 Ant Design Vue 的 Form validate 方法\n```"
+        "```ts\ninterface User { name: string; age: number }\nconst form: Form<User> = useForm({ name: '张三', age: 25 })\n\nform.formData.name           // 直接读写响应式数据\nform.getFormData('name')     // 通过路径读取\nform.setFormData('name', '李四')  // 更新数据\nform.formRef.value?.validate()    // 访问底层 Form 实例\n```"
       ]
     },
     {
       "name": "useForm",
       "type": "function",
       "package": "@qin-ui/antd-vue-pro",
-      "signature": "export const useForm = _useForm as",
-      "description": "创建 @qin-ui/antd-vue-pro 表单实例的 Hook\n类型安全的 re-export。将 core useForm 的泛型参数绑定为本地类型：\n- 字段类型 F → Field<ComponentName, D>（支持 Ant Design Vue 组件类型推导）\n- 表单实例 → Ant Design Vue 的 FormInstance\n使用方式与 core useForm 完全一致，详见 {@link @qin-ui/core} 的 useForm 文档。",
+      "signature": "export function useForm<D extends Data = Data>(\n  initFormData?: ExtendWithAny<DeepPartial<D>>,\n  initFields?: Field<ComponentName, D>[],\n  root?: boolean\n): Form<D, Field<ComponentName, D>>;",
+      "description": "创建表单实例的 Hook\n基于 `@qin-ui/pro-components-core` 的 `useForm`，将泛型参数绑定为 Ant Design Vue 的本地类型：\n- 字段类型 F -> `Field<ComponentName, D>`（支持 Ant Design Vue 所有内置组件类型推导）\n- 表单实例 -> Ant Design Vue 的 `FormInstance`（使 formRef 获得完整的类型提示）\n表单实例组合了三个子模块的能力：\n- **useFormData**：表单数据管理（响应式数据、读写、批量更新）\n- **useFields**：字段配置管理（增删改查字段配置，支持嵌套）\n- **useFormRef**：底层 Form 组件实例引用",
+      "returns": "{Form<D>} 表单实例，包含数据操作、字段操作和 ref 操作",
       "typeParams": [
         {
           "name": "D"
         }
       ],
       "examples": [
-        "```ts\ninterface User { name: string; age: number }\n\nconst form = useForm<User>(\n{ name: '张三', age: 25 },\n[\n{ path: 'name', label: '姓名', component: 'input' },\n{ path: 'age', label: '年龄', component: 'input-number' },\n],\ntrue\n)\n\n// 类型已绑定 Ant Design Vue\nawait form.formRef.value?.validate() // ✅ 类型正确\n```"
+        "```ts\ninterface User { name: string; age: number }\n\n// 方式一：同时传入初始数据和字段\nconst form = useForm<User>(\n{ name: '张三', age: 25 },\n[\n{ path: 'name', label: '姓名', component: 'input' },\n{ path: 'age', label: '年龄', component: 'input-number' },\n],\ntrue\n)\n\n// 方式二：仅设置 root 标识\nconst form = useForm<User>(true)\n\n// 使用\nconst { formData, formRef, fields, setFormData, getField } = form\nsetFormData('name', '李四')\nawait formRef.value?.validate()\n```"
       ]
     },
     {
       "name": "useFormRef",
       "type": "function",
       "package": "@qin-ui/antd-vue-pro",
-      "signature": "export const useFormRef = _useFormRef as",
-      "description": "类型安全的 re-export。将 core useFormRef 的泛型参数绑定为 Ant Design Vue 的 FormInstance，\n使 formRef 获取到完整的 Ant Design Vue Form 组件 API 类型提示。",
-      "returns": "{Function} .setFormRef(inst) - 设置表单组件实例",
+      "signature": "export function useFormRef(): UseFormRefReturn<FormInstance>",
+      "description": "表单组件实例引用 Hook\n基于 `@qin-ui/pro-components-core` 的 `useFormRef`，将泛型参数绑定为 Ant Design Vue 的 `FormInstance`，\n使 formRef 获取到完整的 Ant Design Vue Form 组件 API 类型提示（如 `validate()`、`resetFields()` 等）。\n`formRef` 由 ProForm 组件内部自动通过 `setFormRef` 绑定，无需手动调用。\n- `formRef` — Ant Design Vue Form 组件实例的响应式引用（`Ref<FormInstance | undefined>`）\n- `setFormRef(inst)` — 设置 Form 组件实例，由 ProForm 内部自动调用",
+      "returns": "表单组件实例引用管理对象：",
       "examples": [
-        "```ts\nconst { formRef, setFormRef } = useFormRef()\n// formRef.value 的类型为 FormInstance | undefined\n// 可安全调用 Ant Design Vue 的 Form API\nawait formRef.value?.validate()\nformRef.value?.resetFields()\n```"
+        "```ts\nconst { formRef, setFormRef } = useFormRef()\n\n// formRef 由 ProForm 自动绑定，可直接使用\nawait formRef.value?.validate()\nformRef.value?.resetFields()\nformRef.value?.scrollToField('username')\n```"
       ]
     },
     {
@@ -179,7 +181,7 @@
       "type": "type",
       "package": "@qin-ui/antd-vue-pro",
       "signature": "export type Table<\n  D extends Data = Data,\n  T extends Data = ExtendWithAny<D>,\n> = _Table<D, T, Column<T>>;",
-      "description": "在 core Table 类型的基础上，将列类型 C 绑定为本地 Column<T>，\n使 columns 操作获得 Ant Design Vue 表格列的完整属性类型提示（如 title、width、fixed 等）。",
+      "description": "表格实例类型\n在 core Table 类型的基础上，将列类型 C 绑定为本地 Column<T>，\n使 columns 操作获得 Ant Design Vue 表格列的完整属性类型提示。",
       "typeParams": [
         {
           "name": "D"
@@ -189,15 +191,24 @@
         }
       ],
       "examples": [
-        "```ts\ninterface SearchParams { keyword: string }\ninterface User { name: string; age: number }\n\nconst table: Table<SearchParams, User> = useTable({...})\ntable.columns.value[0].title // 类型为 string | undefined\ntable.columns.value[0].width // 类型为 number | undefined（Ant Design Vue 属性）\n```"
+        "```ts\ninterface SearchParams { keyword: string }\ninterface User { name: string; age: number }\n\nconst table: Table<SearchParams, User> = useTable({\ncolumns: [{ dataIndex: 'name', title: '姓名' }],\n})\n\ntable.columns.value                  // 访问列配置\ntable.setColumn('name', { width: 150 }) // 更新列\ntable.setPageParam({ current: 2 })      // 切换页码\ntable.searchForm.setFormData('keyword', '搜索词') // 操作搜索表单\n```"
       ]
     },
     {
       "name": "useTable",
       "type": "function",
       "package": "@qin-ui/antd-vue-pro",
-      "signature": "export const useTable: <\n  D extends Data = Data,\n  T extends Data = ExtendWithAny<D>,\n>(params:",
-      "description": "创建 @qin-ui/antd-vue-pro 表格实例 of Hook\n类型安全的 re-export。将 core useTable 的列类型绑定为本地 Column<T>，\n使 columns 操作获得 Ant Design Vue 表格列的完整类型提示。\n使用方式与 core useTable 完全一致，详见 `@qin-ui/core` 的 useTable 文档。",
+      "signature": "export function useTable<\n  D extends Data = Data,\n  T extends Data = ExtendWithAny<D>,\n>(params:",
+      "description": "创建表格实例的 Hook\n基于 `@qin-ui/pro-components-core` 的 `useTable`，将列类型绑定为本地 `Column<T>`。\n是 ProTable 组件的核心 Hook，提供了：\n- 列配置管理（增删改查）\n- 数据源管理\n- 分页管理\n- 搜索表单集成（内部使用 useForm）\n- 查询参数重置",
+      "params": [
+        {
+          "name": "params",
+          "type": "object",
+          "optional": false,
+          "description": "表格配置参数"
+        }
+      ],
+      "returns": "{Table<D, T>} 表格实例",
       "typeParams": [
         {
           "name": "D"
@@ -207,7 +218,7 @@
         }
       ],
       "examples": [
-        "```ts\ninterface SearchParams { keyword: string }\ninterface User { name: string; age: number; email: string }\n\nconst table = useTable<SearchParams, User>({\ncolumns: [\n{ key: 'name', title: '姓名', width: 120 },\n{ key: 'age', title: '年龄', width: 80 },\n{ key: 'email', title: '邮箱' },\n],\ndataSource: [],\npageParam: { current: 1, pageSize: 20, total: 0 },\nsearchParam: { keyword: '' },\nsearchFields: [\n{ path: 'keyword', label: '关键词', component: 'input' },\n],\n})\n```"
+        "```ts\ninterface SearchParams { keyword: string; status: string }\ninterface User { name: string; age: number; email: string }\n\nconst table = useTable<SearchParams, User>({\ncolumns: [\n{ dataIndex: 'name', title: '姓名', width: 120 },\n{ dataIndex: 'age', title: '年龄', width: 80 },\n],\ndataSource: [],\npageParam: { current: 1, pageSize: 20, total: 0 },\nsearchParam: { keyword: '', status: '' },\nsearchFields: [\n{ path: 'keyword', label: '关键词', component: 'input' },\n{ path: 'status', label: '状态', component: 'select' },\n],\n})\n\n// 查询\nconst handleSearch = async () => {\nconst res = await fetchUserList({\n...table.searchForm.formData,\n...table.pageParam,\n})\ntable.dataSource.value = res.data\ntable.setPageParam({ total: res.total })\n}\n\n// 重置\nconst handleReset = () => {\ntable.resetQueryParams()\nhandleSearch()\n}\n```"
       ]
     },
     {