Skip to content

Types ​

类型从 dynamicformdjx-vue2/elementUi 导入。

DyFormItem ​

属性类型说明
keystring必填,唯一字段名,也是结果对象的键
valueany必填,字段当前值
labelstring字段标题
hidden / disabledboolean隐藏字段 / 禁用内置输入
requiredboolean生成必填规则
requiredHint(label: string) => string自定义必填提示
ruleobject | object[]字段校验规则
pathstringFormItem 的 prop 与规则键,省略时使用 key;不会自动把结果转换成嵌套对象
span / offsetnumbergrid 布局的列宽 / 偏移;默认 24 / 0
sortnumber升序排列,未设置时排在后面
renderTypeRenderType内置渲染函数名,默认 renderInput
renderPropsobject传给内置渲染函数的组件属性
optionsobject[]选择项
labelField / valueFieldstring选项标题和值的键,默认 label / value
render2(item, setValue) => VNode | VNode[] | null自定义控件,优先于 renderType
onChange(value, item, options?) => void内置控件或 setValue 回写时触发;useDyForm 直接赋值不触发此回调

PresetType ​

ts
import type { DyFormItem, PresetType, ZealColumn, ZealPagination, TableBtnType } from 'dynamicformdjx-vue2/elementUi'
type Row = { name: string; age: number }
const preset: PresetType = 'grid'
const items: DyFormItem<Row>[] = [{ key: 'name', value: '', label: '姓名' }]
const columns: ZealColumn<Row>[] = [{ prop: 'name', label: '姓名' }]

ZealColumn ​

属性类型说明
prop / label / keystring数据字段、标题和唯一标识
type'default' | 'selection' | 'index' | 'expand'列类型
width / minWidthstring 或 number宽度
align'left' | 'center' | 'right'对齐
fixedboolean 或 left / right固定列
slotstring自定义单元格插槽
render2(row, index) => VNode | string | number | null自定义渲染,优先于插槽

ZealPagination / TableBtnType ​

ZealPagination 包含 pageNo、pageSize、total、pageSizes、layout、onChange、onPageSizeChange 和 setTotalSize(total),通常由 usePagination 创建。

TableBtnType 的 key 必填,其他常用字段为 title、disabled、onSelect(key),以及传给 Element UI Button 的属性。