@qin-ui/antd-vue-pro

@qin-ui/antd-vue-pro

基于 Ant Design Vue v4+ 和 Vue 3.x 的二次封装高级组件库，提供高度可配置、Schema 驱动的 ProForm 和 ProTable，助您摆脱繁琐的模板代码，快速搭建桌面端中后台应用。

📝 使用示例和文档详细内容

✨ 核心特性

• 🛡️ 底层坚实：基于 Ant Design Vue 4.x 构建，原生支持 Vue 3.3+。
• 🔥 Schema 驱动：使用声明式 JSON 配置即可快速生成表单，极大地减少了模板文件的编写。
• ⚙️ 动态自适应：支持表单字段的动态隐藏、禁用与规则联动，表格列的动态控制与配置。
• 🧩 极致扩展：原生支持自定义渲染组件与插槽定制，提供 ProComponentProvider 进行全局默认属性覆盖。
• 📐 完美类型推导：基于 TypeScript 提供完备的强类型推导和自动补全，开发体验流畅。

📦 安装

确保您的项目中已安装 ant-design-vue (v4+) 和 vue (v3.3+)：

npm i @qin-ui/antd-vue-pro
# 或使用 pnpm
pnpm add @qin-ui/antd-vue-pro

[!WARNING] 2.0+ 升级提示：2.0 版本进行了底层重构，useForm 返回的 formData 从原本的 ref 包装调整为了真正的 reactive 响应式对象，获取和修改属性时无需使用 .value。

🤖 AI 辅助开发

本项目内置 AI 上下文初始化工具。安装后在项目根目录执行：

npx @qin-ui/antd-vue-pro init-ai

将在项目中生成双载体 AI 上下文，使 Cursor / Claude Code / Codex 等 AI 工具深度理解本库的 Schema 驱动用法与属性透传规则：

• AGENTS.md — 核心使用规则（跨工具开放约定，会话时自动注入，AI 默认加载）
• .agents/skills/antd-vue-pro/SKILL.md — skills 入口（速查 + 参考导航）
• .agents/skills/antd-vue-pro/references/ — 完整使用文档与结构化 API 元数据

生成的 AGENTS.md 使用标记区块写入，重复执行 init-ai 可安全更新，不影响项目内其他库的指令。建议将生成的文件提交到 Git 仓库，团队共享 AI 上下文。

🚀 快速开始

1. 全局注册组件（可选）

import { createApp } from 'vue';
import Antd from 'ant-design-vue';
import 'ant-design-vue/dist/reset.css';
import AntdVuePro from '@qin-ui/antd-vue-pro';
import App from './App.vue';

const app = createApp(App);
app.use(Antd);
app.use(AntdVuePro); // 全局注册 ProForm, ProTable 和 ProComponentProvider
app.mount('#app');

2. 基础表单使用示例

<script setup lang="ts">
import { ProForm, useForm } from '@qin-ui/antd-vue-pro';

interface UserForm {
  username: string;
  age: number;
  gender: string;
}

// 1. 创建类型安全的表单实例
const form = useForm<UserForm>(
  { username: '张三', age: 18, gender: 'male' }, // 初始数据
  [
    {
      path: 'username',
      label: '用户名',
      component: 'input',
      rules: [{ required: true, message: '请输入用户名' }],
    },
    {
      path: 'age',
      label: '年龄',
      component: 'input-number',
      min: 1,
      max: 150,
    },
    {
      path: 'gender',
      label: '性别',
      component: 'select',
      options: [
        { label: '男', value: 'male' },
        { label: '女', value: 'female' },
      ],
    },
  ]
);

// 2. 提交表单校验与数据获取
const handleSubmit = async () => {
  try {
    await form.formRef.value?.validate();
    console.log('提交的数据：', form.formData);
  } catch (error) {
    console.error('校验失败：', error);
  }
};
</script>

<template>
  <div style="padding: 24px; max-width: 600px;">
    <ProForm :form="form" />
    <a-button type="primary" style="margin-top: 16px;" @click="handleSubmit">
      提交表单
    </a-button>
  </div>
</template>

🧱 属性分层透传（核心规则）

ProForm/ProTable 是渲染引擎，所有真实 UI 来自 ant-design-vue。Field 上的属性会被"剥离到不同 DOM 层"，不是全塞给输入控件。写错层就会失效，这是最容易踩的坑：

<a-col :span="8">            ← Grid 层（仅 grid 开启时）
  <a-form-item label="...">  ← FormItem 层
    <a-input placeholder>     ← 输入控件层
  </a-form-item>
</a-col>

规则：span 给 Grid，label/rules 给 FormItem，其余给输入控件。输入控件的具体属性名/类型请以 ant-design-vue 官方文档 为准。

📚 组件 API 说明

1. ProComponentProvider

作为全局或局部范围的上下文配置器，通过传入 componentVars 属性来统一覆盖子组件的默认配置。

Props

内置默认预设（INJECT_CONFIG）

ProComponentProvider 内置了一套默认属性预设，即使不配置 componentVars 也会生效。Field 配置优先级最高，会覆盖这些预设。以下为各组件的内置默认值（写代码时需知晓，避免行为与预期不符）。其中部分值会改变宿主组件原生行为（如 maxlength 静默截断超长输入、input-number 限制数值范围并隐藏步进按钮），排查「输入被截断 / 数值有上限」类问题前先核对本清单：

modelProp 控制 v-model 绑定的属性名，默认 'value'（即 v-model:value）。switch 经预设绑定为 checked，通常无需手动设置。 showTotal（分页总计）与 placeholder 不在 INJECT_CONFIG 预设内，由 locale 体系提供，可在 Field / ProTable 配置中显式覆盖。

2. ProForm

基于 Ant Design Vue Form 深度封装的高级表单组件。

Props

Events & Methods

• 所有事件（如 finish, finishFailed 等）和方法（如 validate, resetFields）均与 Ant Design Vue a-form 组件完全继承，且能直接透传绑定。

3. ProTable

基于 Ant Design Vue Table 深度封装的高级表格组件，将搜索表单、列配置、分页高度集成。

Props

Slots

数据流

ProTable 不会自动请求数据，查询由你提供的 search 回调驱动。内部串联逻辑：

点击搜索  -> 重置分页到第 1 页        -> 调用 search()
分页/排序变化 -> 更新 pageParam        -> 调用 search()
点击重置  -> resetQueryParams()       -> 调用 search()
挂载(immediateSearch) -> 立即触发一次   -> 调用 search()

search 回调内通常组装查询参数并赋值数据源：

const fetchData = async () => {
  const res = await api.list({
    ...table.searchForm.formData, // 搜索条件
    ...table.pageParam, // 分页
  });
  table.dataSource.value = res.data;
  table.setPageParam({ total: res.total });
};

// 重置按钮（ProTable 内部已串联 resetQueryParams -> search，一般无需手动处理）

⚙️ 核心 Hooks 说明

1. useForm

用于创建表单管理对象，整合了表单数据、字段规则和 ref 控制。

入参定义

const form = useForm<D>(initFormData?, initFields?, root?)

• initFormData: 表单初始数据对象（DeepPartial<D>）
• initFields: 初始字段配置数组（Field[]）
• root: 是否创建根 Form 实例，默认为 true。若为 false，则内部会隐式 inject 父级表单上下文。

返回值 (Form 实例)

2. useTable

用于创建和管理表格实例，内置集成了列配置操作与搜索表单组件。

入参参数

const table = useTable<D, T>({
  columns: [], // 初始列配置
  dataSource: [], // 静态初始数据源
  pageParam: {}, // 分页参数配置
  searchParam: {}, // 搜索栏初始数据
  searchFields: [], // 搜索栏字段 Schema 配置
});

返回值 (Table 实例)

列配置（Column）

columns 数组中每一项为 Column<T> 类型，继承 ant-design-vue ColumnType，因此所有原生列属性（title / width / fixed / align / customRender / ellipsis 等）均可用。在此基础上新增：

📄 字段配置（Field）详解

在进行表单 Schema 编写时，Field 数组中的每一项都支持以下属性定义：

公共基础属性

valueFormatter 字段值转换

控制表单值与组件值之间的转换（如日期 dayjs 与字符串互转）。在表单数据写入前（computed setter 中）执行，支持两种形态。函数形态仅 set（写入）方向生效，读取时不转换；对象形态 get/set 双向生效：

// 函数形态：(新值, 旧值) => 转换后的值，写回 formData
{ path: 'name', component: 'input', valueFormatter: (val, oldVal) => val?.trim() }

// 对象形态：get 读出时转换，set 写入时转换
{
  path: 'birthday',
  component: 'date-picker',
  valueFormatter: {
    get: (val) => (val ? dayjs(val) : null),                          // formData -> 组件显示
    set: (val) => (val ? dayjs(val).format('YYYY-MM-DD') : null),     // 组件 -> formData
  },
}

📌 旧值（oldVal）注入契约：仅当转换函数显式声明两个形参 (val, oldVal) => ... 时，底层才读取并传入写入前的旧值快照；声明单形参则不读取旧值（零克隆开销）。请勿使用默认参数或剩余参数声明（否则 fn.length 无法识别）。oldVal 为只读快照副本，不得依赖原地修改写回。

⚠️ valueFormatter 不支持响应式（不能包 ref/computed），与 component / fields / slots / modelProp 等同属不支持响应式的属性。

🔄 响应式联动

控制类属性（disabled / hidden / rules 等）支持三种响应式模式，按场景选最简的：

// A. computed() 声明式 -- 初始化时已知的联动（首选）
disabled: computed(() => !form.formData.enabled),
rules: computed(() => form.formData.hasLimit ? [{ required: true, message: '必填' }] : []),

// B. ref() -- 外部共享状态
const isDisabled = ref(false);
disabled: isDisabled,

// C. setField() 命令式 -- 事件驱动的运行时变更
form.setField('limitCount', { disabled: true });

规则：初始化时已知的联动用 computed()，运行时事件触发的用 setField()，外部共享状态用 ref()。能用 computed() 解决就不要用 setField()。

不支持响应式的属性

以下属性不能包 ref/computed（会失效或引发渲染异常），只能传静态值：

动态切换 component 或 slots 时，用 setField() 命令式更新，而非包 computed。

内置组件映射（component 可选值）

组件库默认封装了 Ant Design Vue 的高频交互组件，您可以在 component 属性中填入以下预设键名来自动调用：

🧩 自定义组件（4 种方式）

Field.component 的解析优先级（高 -> 低）：

teleport 插槽注入 > ProComponentProvider.componentMap > 内置 componentMap > 原始 component 值

方式 1：传入 SFC 单文件组件对象（推荐，单字段最常用）

component 直接传组件对象，必须用 markRaw 包裹：

import { markRaw } from 'vue';
import MyInput from './MyInput.vue';

const fields = [{ path: 'code', label: '验证码', component: markRaw(MyInput) }];

⚠️ 必须 markRaw：不包会被 Vue 当成响应式对象深度代理，触发性能警告甚至渲染异常。类型上 component 接受 RenderComponentType | Raw<RenderComponentType>，Raw<T> 即 markRaw 的类型标记。此字段不支持响应式（不能包 ref/computed）。

方式 2：传入 render 函数（单字段，需动态拼装 props 时）

component 传 (props, ctx) => VNode。props 含 v-model 绑定值与 path，ctx.attrs 含透传属性：

import { h } from 'vue';
import MyInput from './MyInput.vue';

const fields = [
  {
    path: 'code',
    label: '验证码',
    component: (p, ctx) => h(MyInput, { ...p, ...ctx.attrs }),
  },
];

方式 3：ProComponentProvider 注入 componentMap（全局复用，推荐多字段场景）

在根用 componentMap 注册，Field 里用字符串引用。可覆盖内置组件（如 input: MyInput 替换全局 input）。

<script setup lang="ts">
import { ProComponentProvider } from '@qin-ui/antd-vue-pro';
import MyRichTextEditor from './components/MyRichTextEditor.vue';

const componentMap = {
  'rich-editor': MyRichTextEditor,
};
</script>

<template>
  <ProComponentProvider :component-map="componentMap">
    <AppLayout />
  </ProComponentProvider>
</template>

追加 TypeScript 全局声明获取强类型补全（项目任意 .d.ts）：

declare module '@qin-ui/antd-vue-pro' {
  interface ComponentMap {
    'rich-editor': typeof MyRichTextEditor;
  }
}

之后 component: 'rich-editor' 即获精准属性类型联想与校验。

方式 4：模板 scoped slot（声明式，简单替换）

插槽名 = 字段 path，绑定参数通过 v-bind="scoped" 转发（teleport 机制，优先级最高）：

<ProForm :form="form">
  <template #agreement="scoped">
    <a-checkbox v-bind="scoped">同意协议</a-checkbox>
  </template>
</ProForm>

选择建议

自定义组件需遵守的约定

• v-model：默认绑 value（v-model:value）。若组件用别的 prop（如 Switch 用 checked），通过字段 modelProp 指定，或在 componentVars 预设 modelProp。
• 接收 path：组件会收到 path prop（字段路径），可用于透传或标识。
• 属性透传：Field 上除框架级属性外（component / hidden / modelProp / valueFormatter / fields / slots / formItemContainer / componentContainer / extraProps 等），其余作为 attrs 透传给自定义组件。

Peer Dependencies

🤝 贡献与反馈

欢迎在任何时候通过 GitHub Issues 提交对本子包的优化建议和反馈。

📄 开源许可证

基于 MIT 开源许可证。