FormKit logo

FormKit

面向 AI 编程代理的表单框架——为 Vue 3 和 React 提供开箱即用的高质量表单开发体验。

表单校验VueReactAI 编程代理

FormKit 是面向 AI 编程代理的表单框架,采用单组件 API 设计,内置 30+ 验证规则和 24+ 输入类型,支持 Vue 3 和 React 双框架,提供 JSON 可序列化的 Schema 动态表单能力。

FormKit

面向 AI 编程代理的表单框架——为 Vue 3 和 React 提供开箱即用的高质量表单开发体验。

技术简介说明

FormKit 是一个开源的表单创作框架,由 Justin Schroeder 创建,最初作为 Vue Formulate 的精神继任者从零构建。它不是 Vue Formulate 的简单移植,而是对 Vue 表单开发方式的全面重新设计。FormKit 将框架无关的核心逻辑与框架绑定层清晰分离,同一套核心验证规则、Schema 和架构可以同时驱动 Vue 3 和 React 应用。

FormKit 的核心设计哲学是「单组件 API」——几乎所有表单行为(验证规则、错误消息、帮助文本、输入类型)都通过声明式属性直接写在 <FormKit> 组件上。这种设计不仅让开发者能够快速构建复杂表单,更使其成为 AI 编程代理生成表单代码的理想目标:AI 只需理解一个组件的接口即可完成从简单输入到复杂嵌套表单的全部工作。

2026 年发布的 FormKit 2.0 标志着其从「Vue 专属表单库」转型为「跨框架表单框架」,新增 React 支持,并将自身定位为「面向编程代理的表单框架」。这一转变反映了前端开发工具向 AI 辅助开发范式演进的趋势。

基本信息

  • 官网:https://formkit.com
  • GitHub:https://github.com/formkit/formkit
  • License:MIT
  • 最新版本:v2.1.0(2026 年 6 月)
  • 主要维护者/公司:Justin Schroeder / Standard Labs(美国弗吉尼亚州夏洛茨维尔)
  • GitHub Stars:约 4,700+
  • npm 周下载量:@formkit/vue 约 50K+;@formkit/auto-animate 约 850K+

快速上手

安装

# Vue 3 项目
pnpm add @formkit/vue
 
# React 项目(FormKit 2.0+)
pnpm add @formkit/react

基础配置

Vue 3 配置

// main.ts
import { createApp } from 'vue'
import { plugin, defaultConfig } from '@formkit/vue'
import App from './App.vue'
 
const app = createApp(App)
 
app.use(plugin, defaultConfig)
 
app.mount('#app')

React 配置

// main.tsx
import { FormKitProvider } from '@formkit/react'
 
function App() {
  return (
    <FormKitProvider>
      {/* 你的表单内容 */}
    </FormKitProvider>
  )
}

最小示例

<script setup lang="ts">
import { ref } from 'vue'
 
const formValue = ref({})
 
const handleSubmit = (data: Record<string, unknown>) => {
  console.log('表单数据:', data)
}
</script>
 
<template>
  <FormKit
    type="form"
    v-model="formValue"
    @submit="handleSubmit"
  >
    <FormKit
      type="text"
      name="username"
      label="用户名"
      validation="required|length:3,20"
      help="请输入 3-20 个字符的用户名"
    />
    <FormKit
      type="email"
      name="email"
      label="邮箱"
      validation="required|email"
    />
    <FormKit
      type="password"
      name="password"
      label="密码"
      validation="required|length:8,100"
    />
    <FormKit
      type="password"
      name="password_confirm"
      label="确认密码"
      validation="required|confirm:password"
    />
  </FormKit>
</template>

核心概念与架构

框架无关的核心层

FormKit 采用分层架构,将框架无关的核心逻辑(@formkit/core)与框架绑定层(@formkit/vue@formkit/react)清晰分离。核心层负责:

  • 表单状态管理:输入值、验证状态、错误信息、提交状态
  • 节点树(Node Tree):每个输入对应一个响应式节点,父子节点构成树形结构
  • 验证引擎:内置 30+ 验证规则,支持自定义规则和异步验证
  • 配置系统:层级化配置(全局 → 表单级 → 输入级),子级自动继承父级配置

Context 对象

每个 FormKit 输入都会生成一个响应式的 Context 对象,它是表单系统的核心数据结构:

interface FormKitContext {
  value: unknown        // 当前值
  _value: unknown       // 原始值
  node: FormKitNode     // 节点引用
  id: string            // 唯一 ID
  name: string          // 字段名
  type: string          // 输入类型
  errors: string[]      // 错误列表
  state: FormKitState   // 状态标志
  config: FormKitConfig // 配置
}

FormKit Schema

FormKit Schema 是一种 JSON 可序列化的数据格式,用于描述任意 HTML 或组件模板结构。它支持条件渲染、动态插槽、表达式求值等高级特性,适合后端驱动表单或表单构建器场景:

const schema = [
  {
    $formkit: 'text',
    name: 'name',
    label: '姓名',
    validation: 'required'
  },
  {
    $formkit: 'select',
    name: 'role',
    label: '角色',
    options: ['admin', 'user', 'guest'],
    validation: 'required'
  }
]

核心特性

  • 单组件 API:所有表单行为通过声明式属性在 &lt;FormKit&gt; 组件上配置,AI 代理友好
  • 30+ 内置验证规则:包括 requiredemaillengthmatchesafterbeforeconfirm 等,支持字符串和数组两种语法
  • 异步验证:原生支持异步验证规则,适用于用户名唯一性检查、服务端验证等场景
  • 自定义验证规则:支持全局注册和局部注册,规则函数可返回布尔值或自定义错误消息字符串
  • 24+ 可访问输入类型:text、email、password、select、checkbox、radio、date、textarea、file、number、range、toggle 等,均内置 ARIA 无障碍支持
  • FormKit Schema:JSON 可序列化的表单描述格式,适合后端驱动表单和表单构建器
  • 层级化配置系统:全局 → 表单级 → 输入级三层配置,子级自动继承并覆盖父级设置
  • 国际化(i18n)支持:内置多语言验证消息,支持自定义翻译
  • 主题系统:CSS 原生主题 + Tailwind CSS 主题 + 自定义主题,FormKit Pro 提供高级主题
  • React 支持(2.0 新增):同一核心驱动 Vue 3 和 React,共享验证规则和 Schema

生态图

官方生态

包名说明
@formkit/core框架无关的核心逻辑
@formkit/vueVue 3 绑定层
@formkit/reactReact 绑定层(2.0 新增)
@formkit/themes主题系统(CSS / Tailwind / Bootstrap)
@formkit/i18n国际化支持
@formkit/addons附加功能包
@formkit/drag-and-drop独立的拖拽排序库(框架无关,13.9K Stars)
@formkit/auto-animate零配置动画工具(13.9K Stars,约 850K 周下载量)
@formkit/tempo日期处理库,支持复杂时区操作
@formkit/nuxtNuxt 3 模块集成

FormKit Pro(付费)

FormKit Pro 是高级输入组件库,提供:

  • Datepicker:功能丰富的日期选择器
  • Dropdown:可搜索、多选的下拉组件
  • Autocomplete:自动补全输入
  • Repeater:可重复的字段组(动态增减)
  • Currency:货币格式化输入
  • Unit:单位输入
  • 高级主题:包括基于 Tailwind 的 "Regenesis" 主题等

第三方生态

  • @sfxcode/formkit-primevue-nuxt:PrimeVue + Nuxt 集成
  • @sfxcode/nuxt-ui-formkit:Nuxt UI 集成
  • formkit-element:Element Plus 集成
  • shadcn-zod-formkit:ShadCN + Zod + FormKit 集成

关键依赖

  • Vue 3.3+(Vue 绑定层)
  • React 18+(React 绑定层)
  • TypeScript 5+(完整类型支持)

适用场景

  • 企业级表单应用:CRM、ERP、后台管理系统等表单密集场景,FormKit 的层级配置和内置验证能大幅减少样板代码
  • 表单构建器/低代码平台:FormKit Schema 的 JSON 可序列化特性天然适合后端驱动的动态表单生成
  • AI 辅助开发项目:单组件 API 设计使 AI 编码代理能高效生成表单代码,2.0 版本专门为此优化
  • 多语言表单应用:内置 i18n 支持,验证消息自动翻译,适合国际化产品
  • 可访问性要求高的项目:所有内置输入类型均支持 ARIA 属性,适合政务、医疗、教育等无障碍要求高的领域
  • 跨框架项目:2.0 起同时支持 Vue 3 和 React,适合 Monorepo 中混用多框架的场景
  • 复杂表单交互:条件显示、动态字段、嵌套分组、依赖联动等高级场景,Schema 表达式和 Context 对象提供完整支持

开发与工程化

开发流程

# 克隆仓库
git clone https://github.com/formkit/formkit.git
cd formkit
 
# 安装依赖(使用 pnpm)
pnpm install
 
# 启动开发模式
pnpm dev
 
# 运行测试
pnpm test

构建

# 构建所有包
pnpm build
 
# 构建单个包
pnpm --filter @formkit/vue build

工程化最佳实践

  1. Schema 与组件分离:对于复杂表单,将 Schema 定义为独立常量文件,便于测试和复用
  2. 自定义输入类型:对于项目特有的输入组件,通过 inputs 配置注册为自定义 FormKit 输入类型
  3. 主题统一管理:使用 Tailwind 主题或自定义 CSS 主题,通过全局配置统一应用
  4. 验证规则复用:将自定义验证规则抽离到独立文件,通过全局配置注册
  5. Pro 组件按需引入:FormKit Pro 组件按需引入,避免不必要的包体积增加

CI/CD 集成

FormKit 作为纯前端库,CI/CD 集成要点:

  • 类型检查:pnpm typecheck 确保 Schema 和验证规则的类型正确性
  • 构建验证:pnpm build 确认无构建错误
  • 快照测试:对关键表单组件进行快照测试,防止 UI 回归
  • E2E 测试:使用 Playwright / Cypress 测试表单提交流程

性能与安全

性能特点

  • 懒加载支持:FormKit Schema 支持动态加载,大型表单可按需渲染
  • 按需引入:通过 @formkit/vue 的 tree-shaking 支持,未使用的输入类型不会被打包
  • Context 响应式优化:每个输入的 Context 对象独立响应,避免全局状态变更触发不必要的重渲染

性能优化建议

  1. 避免过度嵌套:深层嵌套的 group/form 结构会增加节点树的遍历成本
  2. 合理使用 Schema:对于静态表单,直接使用组件模板比 Schema 解析更高效
  3. 表单分页:对于超长表单(50+ 字段),考虑使用多步骤表单或条件显示
  4. 异步验证防抖:为异步验证规则设置合理的延迟,避免频繁请求

安全注意事项

  • FormKit 不自动转义 HTML,在使用自定义输入组件时注意 XSS 防护
  • 验证规则不应替代服务端验证——FormKit 的客户端验证提升 UX,但敏感数据必须在服务端二次验证
  • 文件上传类型(type="file")需要配合服务端安全策略(文件类型、大小限制)

技术对比

特性FormKitVeeValidateVuelidateFormwerk
定位完整表单框架轻量验证库轻量验证库Headless 表单库
Vue 支持Vue 3(核心)Vue 2 + 3Vue 2 + 3Vue 3
React 支持✅(2.0+)
内置输入组件24+ 种
内置验证规则30+需配合 vee-validate/rules基础规则需自行集成
Schema 支持✅ JSON Schema
异步验证✅ 原生
i18n 支持✅ 内置✅ 需配置✅ 需配置
主题系统✅ CSS/Tailwind/Pro
包体积较大(完整框架)小(~13KB)小(~10KB)
AI 代理友好✅ 专门优化一般一般一般
学习曲线中等中等
适用规模中大型项目任意规模小型项目中型项目

选型建议

  • 选 FormKit:当你需要一个完整的表单解决方案(输入组件 + 验证 + 主题 + i18n),或项目中有大量表单需要快速开发
  • 选 VeeValidate:当你已有自定义 UI 组件库,只需要验证逻辑,且希望保持轻量
  • 选 Vuelidate:当你只需要最简单的验证方案,且项目规模较小
  • 选 Formwerk:当你想要 headless 方案,自己控制所有 UI 渲染

最佳实践

1. 验证规则分层

<!-- ✅ 推荐:使用字符串语法简洁声明 -->
<FormKit
  type="text"
  name="email"
  validation="required|email"
  validation-messages="{
    required: '请输入邮箱地址',
    email: '请输入有效的邮箱格式'
  }"
/>

2. 自定义验证规则全局注册

// plugins/formkit.ts
import { createRule } from '@formkit/validation'
 
const phoneRule = createRule((value) => {
  return /^1[3-9]\d{9}$/.test(value)
})
 
export const formKitConfig = defaultConfig({
  rules: {
    phone: phoneRule
  }
})

3. 表单数据提交处理

<script setup lang="ts">
const handleSubmit = async (data: FormData, node: FormKitNode) => {
  try {
    // node 提供表单状态控制能力
    await api.submit(data)
    node.setErrors([])  // 清除错误
  } catch (error) {
    // 服务端验证错误映射到对应字段
    node.setErrors([], {
      email: '该邮箱已被注册'
    })
  }
}
</script>

4. Schema 动态表单

<script setup lang="ts">
const schema = computed(() => [
  {
    $formkit: 'text',
    name: 'name',
    label: '姓名',
    validation: 'required'
  },
  // 条件显示
  {
    if: '$get(type).value === "company"',
    $formkit: 'text',
    name: 'company',
    label: '公司名称',
    validation: 'required'
  }
])
</script>
 
<template>
  <FormKitSchema :schema="schema" />
</template>

5. 常见陷阱

  • 不要在 FormKit 外部管理表单状态:FormKit 内部维护完整的状态树,外部 v-model 只用于读取最终值,不要试图从外部修改单个字段
  • 不要忽略 name 属性:每个 FormKit 输入必须有 name,否则数据不会被收集
  • 不要混用 HTML 表单元素和 FormKit&lt;input&gt; 标签不受 FormKit 管理,统一使用 &lt;FormKit type="..."&gt;
  • 善用 validation-visibility:默认在 blur 后显示错误,可通过 validation-visibility="live" 实时显示

技术局限与边界

已知限制

  1. 包体积较大:作为完整表单框架,FormKit 的包体积显著大于纯验证库(VeeValidate ~13KB)。如果只需要验证逻辑,FormKit 过于重量级
  2. Vue 生态为主:虽然 2.0 增加了 React 支持,但 React 生态的社区资源、示例和第三方集成仍远不如 Vue 成熟
  3. Pro 功能付费:Datepicker、Dropdown、Autocomplete 等高级输入组件需要 FormKit Pro 付费许可
  4. 自定义 UI 受限:FormKit 的输入组件有固定的 DOM 结构和 CSS 类名体系,如果你的设计系统需要完全自定义的 DOM 结构,需要深度定制主题或使用 Schema 插槽
  5. Schema 学习曲线:FormKit Schema 的表达式语法、条件渲染、插槽系统需要额外学习成本

不适用场景

  • 极简表单:只需要 1-2 个输入字段的简单场景,原生 HTML 表单 + 简单校验即可
  • 已有成熟 UI 库的项目:如果项目已使用 Element Plus / Ant Design Vue 等完整 UI 库,FormKit 的输入组件可能与之冲突或冗余
  • Headless 表单需求:如果你只需要状态管理和验证逻辑、完全控制 UI 渲染,考虑 VeeValidate 或 Formwerk
  • 非 Vue/React 框架:FormKit 目前仅支持 Vue 3 和 React,不支持 Svelte、Angular 等

迁移注意事项

  • 从 Vue Formulate 迁移:FormKit 是 Vue Formulate 的精神继任者,但 API 完全不同,需要全面重写
  • 从 VeeValidate 迁移:需要将验证逻辑从 VeeValidate 规则语法迁移到 FormKit 规则语法,两者语法相似但不完全一致
  • 升级 1.x → 2.0:2.0 新增 React 支持,但 Vue API 基本保持兼容;主要变化是 CLI 工具升级和 Bug 修复

学习资源

2026 年现状

最新版本

  • v2.1.0(2026 年 6 月 10 日):最新稳定版本,包含 Bug 修复
  • v2.0.0(2026 年 4 月 2 日):重大版本更新,新增 React 支持,重新定位为「面向编程代理的表单框架」

发展趋势

  1. 跨框架转型:FormKit 2.0 从 Vue 专属转向 Vue + React 双框架支持,未来可能扩展更多框架
  2. AI 代理优先:单组件 API 设计 + SKILL.md 文件专门优化了 AI 编码代理的使用体验,这在前端框架中是首创的定位
  3. 独立生态扩展@formkit/drag-and-drop(13.9K Stars)和 @formkit/auto-animate(13.9K Stars)已发展为独立的高人气项目
  4. Pro 功能持续迭代:FormKit Pro 持续增加高级输入组件和主题

社区活跃度

  • GitHub Stars:约 4,700+
  • npm 周下载量:@formkit/vue 约 50K+(主包),@formkit/auto-animate 约 850K+
  • GitHub Issues / Discussions 活跃维护
  • 第三方集成持续增加(Nuxt UI、PrimeVue、Element Plus 等)

未来路线图

  • React 生态的进一步完善和第三方集成
  • AI 编程代理工具的更深度集成(CLI 工具 + Skill 文件)
  • FormKit Pro 高级组件的持续扩展
  • 更多框架支持的可能性(基于核心层的框架无关设计)