useCrudForm

表单状态管理：model、mode、dirty 检测、变更数据裁剪、可见字段过滤。

基本用法

import { useCrudForm } from '@uozi/vito-core'

const form = useCrudForm<MyRow>({
  fields: [
    { key: 'name', label: '名称', type: 'text', required: true, visibleIn: { editForm: true } },
    { key: 'status', label: '状态', type: 'select', visibleIn: { editForm: true } },
  ],
})

// 新增模式
form.setMode('create')
form.reset({ name: '默认值' })

// 编辑模式
form.setMode('edit')
form.reset(existingRow)

// 获取提交数据
const data = form.getSubmitData()
// create 模式: 返回整个 model
// edit 模式: 只返回 changedData（变更字段）

Options

参数	类型	默认值	说明
fields	CrudField<Row>[]	—	字段定义（必填）
initialData	Partial<Row>	{}	初始数据

返回值

State

属性	类型	说明
model	Reactive<Partial<Row>>	响应式表单对象
mode	Ref<'create' | 'edit'>	当前模式
dirty	ComputedRef<boolean>	model 是否与初始快照不同
changedKeys	ComputedRef<string[]>	变更的字段 key 列表
changedData	ComputedRef<Partial<Row>>	仅包含变更字段的数据
visibleFields	ComputedRef<CrudField<Row>[]>	按 visibleIn.editForm 过滤后的字段

Actions

方法	签名	说明
reset	(data?: Partial<Row>) => void	重置 model 和初始快照
setMode	(mode: 'create' | 'edit') => void	切换模式
getSubmitData	() => Partial<Row>	获取提交数据

行为说明

dirty / changedData

useCrudForm 在 reset() 时拍一个初始快照。后续修改 model 时，dirty / changedKeys / changedData 通过浅比较计算：

• dirty：任一字段值与快照不同
• changedKeys：所有变更字段的 key
• changedData：只包含变更字段的子集

getSubmitData

模式	返回值	说明
create	整个 model	新增通常需要完整数据
edit	changedData	编辑只提交变更字段，节省带宽、减少冲突

visibleFields

根据 visibleIn.editForm 过滤。如果 visibleIn.editForm 是函数，会传入 FieldContext（包含 formModel），支持条件渲染。

完整示例

页面

<script setup lang="ts">
import type { CrudAdapter } from '@uozi/vito-core'
import type { DemoQuery, DemoRow } from './basic-types'
import { useCrudForm, useCrudList, useCrudSelection } from '@uozi/vito-core'
import { CrudForm, CrudSearch, CrudTable, defineColumns, defineFields } from '@uozi/vito-naive-ui'
import { NButton, NCard, NSpace } from 'naive-ui'
import { onMounted, ref } from 'vue'
import { createBasicAdapter } from './basic-adapter'

const { adapter } = createBasicAdapter()

const fields = defineFields<DemoRow>([
  { key: 'name', label: '名称', type: 'text', required: true, visibleIn: { searchForm: true, table: true, editForm: true } },
  { key: 'status', label: '状态', type: 'select', visibleIn: { searchForm: true, table: true, editForm: true } },
  { key: 'amount', label: '金额', type: 'number', visibleIn: { searchForm: false, table: true, editForm: true } },
])

const columns = defineColumns<DemoRow>([
  { key: 'name', label: '名称', sortable: true, width: 220 },
  { key: 'status', label: '状态', width: 120 },
  { key: 'amount', label: '金额', sortable: true, width: 120 },
])

const list = useCrudList<DemoRow, DemoQuery>({
  adapter: adapter as CrudAdapter<DemoRow, DemoQuery>,
  initialQuery: { search: {} },
})

const selection = useCrudSelection<DemoRow>({
  rows: list.rows,
  getId: adapter.getId,
})

const form = useCrudForm<DemoRow>({
  fields: fields as any,
})

const visible = ref(false)
const editing = ref<DemoRow | null>(null)

function openCreate() {
  editing.value = null
  form.setMode('create')
  form.reset()
  visible.value = true
}

function openEdit(row: DemoRow) {
  editing.value = row
  form.setMode('edit')
  form.reset(row)
  visible.value = true
}

async function handleSubmit(data: Partial<DemoRow>) {
  if (form.mode.value === 'create')
    await adapter.create?.(data as any)
  else if (editing.value)
    await adapter.update?.(editing.value.id, data as any)

  visible.value = false
  await list.refresh()
}

onMounted(() => {
  void list.refresh()
})
</script>

<template>
  <NCard title="手动组合：CrudSearch + CrudTable + CrudForm">
    <template #header-extra>
      <NSpace>
        <NButton
          type="primary"
          @click="openCreate"
        >
          新增
        </NButton>
      </NSpace>
    </template>

    <CrudSearch
      :list="list"
      :fields="(fields as any)"
      query-key="search"
    />

    <CrudTable
      :list="list"
      :columns="columns"
      :selection="selection"
      :row-key="(row: DemoRow) => row.id"
      show-actions-column
    >
      <template #row-actions="{ row }">
        <NSpace>
          <NButton
            size="small"
            @click="openEdit(row)"
          >
            编辑
          </NButton>
        </NSpace>
      </template>
    </CrudTable>

    <CrudForm
      v-model:visible="visible"
      :form="form"
      :fields="(fields as any)"
      display-mode="modal"
      @submit="handleSubmit"
    />
  </NCard>
</template>

Adapter

import type { CrudAdapter, CrudSort, ListResult } from '@uozi/vito-core'
import type { DemoQuery, DemoRow } from './basic-types'

function compare(a: unknown, b: unknown): number {
  if (a === b)
    return 0
  if (a === null || a === undefined)
    return -1
  if (b === null || b === undefined)
    return 1
  if (typeof a === 'number' && typeof b === 'number')
    return a - b
  return String(a).localeCompare(String(b))
}

function sortRows(rows: DemoRow[], sort?: CrudSort | null): DemoRow[] {
  if (!sort)
    return rows
  const dir = sort.order === 'descend' ? -1 : 1
  return rows.slice().sort((ra, rb) => dir * compare((ra as any)[sort.field], (rb as any)[sort.field]))
}

function filterRows(rows: DemoRow[], query: DemoQuery): DemoRow[] {
  const s = query.search ?? {}
  const name = s.name?.trim() ?? null
  const status = s.status ?? null
  return rows.filter((r) => {
    if (name && !r.name.toLowerCase().includes(name.toLowerCase()))
      return false
    if (status && r.status !== status)
      return false
    return true
  })
}

function createSeed(): DemoRow[] {
  const now = Date.now()
  return [
    { id: 1, name: '示例 1', status: 'enabled', amount: 12.3, createdAt: now - 3600_000 },
    { id: 2, name: '示例 2', status: 'draft', amount: 45.6, createdAt: now - 7200_000 },
    { id: 3, name: '示例 3', status: 'disabled', amount: 78.9, createdAt: now - 10800_000 },
  ]
}

export function createBasicAdapter(initial?: DemoRow[]): {
  adapter: CrudAdapter<DemoRow, DemoQuery>
  reset: (next?: DemoRow[]) => void
  getAll: () => DemoRow[]
} {
  let db = (initial ?? createSeed()).slice()
  let idSeq = db.reduce((m, r) => Math.max(m, r.id), 0) + 1

  function getAll() {
    return db.slice()
  }

  function reset(next?: DemoRow[]) {
    db = (next ?? createSeed()).slice()
    idSeq = db.reduce((m, r) => Math.max(m, r.id), 0) + 1
  }

  const adapter: CrudAdapter<DemoRow, DemoQuery> = {
    getId(row) {
      return row.id
    },
    async list(params): Promise<ListResult<DemoRow>> {
      const filtered = filterRows(db, params.query)
      const sorted = sortRows(filtered, params.sort)
      const page = Math.max(1, params.page)
      const pageSize = Math.max(1, params.pageSize)
      const start = (page - 1) * pageSize
      return {
        items: sorted.slice(start, start + pageSize),
        total: sorted.length,
      }
    },
    async create(data): Promise<DemoRow> {
      const row: DemoRow = {
        id: idSeq++,
        name: String((data as any)?.name ?? ''),
        status: ((data as any)?.status ?? 'draft') as DemoRow['status'],
        amount: Number((data as any)?.amount ?? 0),
        createdAt: Date.now(),
      }
      db = [row, ...db]
      return row
    },
    async update(id, data): Promise<DemoRow> {
      const idx = db.findIndex(r => r.id === id)
      if (idx < 0)
        throw new Error(`记录不存在：${id}`)
      const next: DemoRow = { ...db[idx], ...(data as any), id: db[idx].id }
      db = db.slice()
      db[idx] = next
      return next
    },
    async remove(id): Promise<void> {
      db = db.filter(r => r.id !== id)
    },
  }

  return { adapter, reset, getAll }
}

类型定义

export interface DemoRow {
  id: number
  name: string
  status: 'draft' | 'enabled' | 'disabled'
  amount: number
  createdAt: number
}

export interface DemoQuery {
  search?: {
    name?: string | null
    status?: DemoRow['status'] | null
  }
}