可通过 rules 配置校验规则。其中 typeMatch: true 会按字段 type（以及 filter / valueFormat 等）校验值是否合法，详见表单校验。
{
name: 'text',
text: '输入框',
rules: [
{ required: true, message: '请输入' },
{ typeMatch: true, message: '值类型不合法' },
],
}| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| name | 绑定值 | string | — | — |
| text | 表单标签 | string | — | — |
| placeholder | 输入框占位文本 | string | — | — |
| disabled | 是否禁用 | boolean / FilterFunction | — | false |
| clearable | 是否可清空 | boolean | — | true |
| tooltip | 输入时显示内容 | string / ToolTipConfigType | — | — |
| trim | 是否去掉首尾空格 | boolean | — | false |
| filter | 过滤值 | string / Function | number | - |
| rules | 表单验证规则 | Rule[] | — | — |
| prepend | 前置内容 | string | — | - |
| append | 后置内容 | string / Object | — | - |
| onChange | 值变化时触发的函数 | OnChangeHandler | — | - |
export type FilterFunction<T = boolean> = (
mForm: FormState | undefined,
data: {
model: FormValue;
values: FormValue;
parent?: FormValue;
formValue: FormValue;
prop: string;
config: any;
index?: number;
getFormValue: (prop: string) => any;
},
) => T;export type OnChangeHandler = (mForm: FormState | undefined, value: any, data: OnChangeHandlerData) => any;export interface OnChangeHandlerData {
model: FormValue;
values?: Readonly<FormValue> | null;
parent?: FormValue;
formValue?: FormValue;
config: Readonly<any>;
prop: string;
changeRecords: ChangeRecord[];
setModel: (prop: string, value: any) => void;
setFormValue: (prop: string, value: any) => void;
}export interface ChangeRecord {
propPath?: string;
value: any;
}export type FormValue = Record<string | number, any>;export type ToolTipConfigType = string | { text?: string; placement?: string };export interface Rule {
message?: string;
/** 系统提供的验证器类型。有：string,number,boolean,method,regexp,integer,float,array,object,enum,date,url,hex,email,any */
type?: string;
/** 是否按字段 config.type 校验值类型/选项匹配 */
typeMatch?: boolean;
/** 是否必填 */
required?: boolean;
trigger?: string;
/** 自定义验证器 */
validator?: (
options: {
rule: string;
value: any;
callback: Function;
source: Object;
options: {
messages: string;
};
},
data: {
/** 表单的初始值 */
values: FormValue;
/** 当前作用域下的值 */
model: FormValue;
parent: FormValue;
/** 整个表单的值 */
formValue: FormValue;
prop: string;
config: any;
},
mForm: FormState | undefined,
) => void;
}export interface TextConfig extends FormItem, Input {
type?: 'text';
tooltip?: string;
/** 是否可清空 */
clearable?: boolean;
/**
* 是否以纯文本（非输入框）形态渲染。
* 开启后字段值以 \`<span>\` 展示，不参与编辑，但保留 \`prepend\` / \`append\` 槽位，
* 适合用于「只读但需要保留操作按钮（如复制 icon）」的场景。
*/
static?: boolean;
prepend?: string;
/** 后置元素，一般为标签或按钮 */
append?:
| string
| {
text: string;
value?: 0 | 1;
type: 'button' | 'icon';
extra?: string;
handler?: (
mForm: FormState | undefined,
data: {
model: any;
values?: Readonly<FormValue> | null;
formValue?: FormValue;
setModel: (prop: string, value: any) => void;
setFormValue: (prop: string, value: any) => void;
},
) => void | Promise<void>;
};
}export interface FormItem {
/** vnode的key值，默认是遍历数组时的index */
__key?: string | number;
/** 表单域标签的的宽度，例如 '50px'。支持 auto。 */
labelWidth?: string | number;
/** label 标签的title属性 */
labelTitle?: string;
className?: string;
/** 字段名 */
name?: string | number;
/** 额外的提示信息，和 help 类似，当提示文案同时出现时，可以使用这个。 */
extra?: string | FilterFunction<string>;
/** 额外的提示信息，和 extra 类似，着重强调时用这个显示，优先级高于extra*/
extraTips?: string;
/** 配置提示信息 */
tooltip?: ToolTipConfigType | FilterFunction<ToolTipConfigType>;
/** 是否置灰 */
disabled?: boolean | FilterFunction;
/** 使用表单中的值作为key，例如配置了text，则使用model.text作为key */
key?: string;
/** 是否显示 */
display?: boolean | 'expand' | FilterFunction<boolean | 'expand'>;
/** 值发生改变时调用的方法 */
onChange?: OnChangeHandler;
/** label 标签的文本 */
text?: string | FilterFunction<string>;
/** 右侧感叹号 */
tip?: string;
filter?: 'number' | OnChangeHandler;
/** 是否去除首尾空格 */
trim?: boolean;
/** 默认值 */
defaultValue?: any | DefaultValueFunction;
/** 标题下方的额外提示信息 */
titleExtra?: string;
/** 表单验证规则 */
rules?: Rule[];
extensible?: boolean;
dynamicKey?: string;
/** 是否需要显示\`展开更多配置\` */
expand?: boolean;
style?: Record<string, any>;
fieldStyle?: Record<string, any>;
labelPosition?: 'top' | 'left' | 'right';
flat?: boolean;
fixed?: boolean | 'left' | 'right';
operateColWidth?: number | string;
}export interface Input {
/** 输入框没有内容时显示的文案 */
placeholder?: string;
}| 参数 | 说明 | 类型 | 可选值 | 默认值 |
|---|---|---|---|---|
| type | 内容类型 | string | button | — |
| text | 文本内容 | string | — | — |
| handler | 点击操作 | Function | — | - |