Skip to content
On this page

Class: FormHelper

Hierarchy

Constructors

constructor

new FormHelper(options?)

Parameters

NameType
options?Partial<FormHelperOptions>

Defined in

dist/src/components/form-helper/form-helper.d.ts:8

Properties

data

data: Record<string, any>

Defined in

dist/src/components/form-helper/form-helper.d.ts:11


fields

fields: FormItem<any>[]

Defined in

dist/src/components/form-helper/form-helper.d.ts:10


onFormItemControlChange

onFormItemControlChange: (name: string, value: any) => void

Type declaration

(name, value): void

表单项控件值变化后的回调函数.

Parameters
NameType
namestring
valueany
Returns

void

Defined in

dist/src/components/form-helper/form-helper.d.ts:17


onValidateError

onValidateError: (error: any) => void

Type declaration

(error): void

Parameters
NameType
errorany
Returns

void

Defined in

dist/src/components/form-helper/form-helper.d.ts:18


preset

preset: Partial<Record<FormItemControlType, any>>

Defined in

dist/src/components/form-helper/form-helper.d.ts:9


rawData

rawData: Record<string, any>

Defined in

dist/src/components/form-helper/form-helper.d.ts:12


validator

validator: FormValidator

Defined in

dist/src/components/form-helper/form-helper.d.ts:13

Methods

addFields

addFields(...fields): void

Parameters

NameType
...fieldsFormModelFieldArgs<any>[]

Returns

void

Defined in

dist/src/components/form-helper/form-helper.d.ts:19


getField

getField(name): undefined | FormItem<any>

获取与 name 对应的表单项控件对象.

Parameters

NameType
namestring

Returns

undefined | FormItem<any>

Defined in

dist/src/components/form-helper/form-helper.d.ts:45


removeFields

removeFields(...names): void

Parameters

NameType
...namesstring[]

Returns

void

Defined in

dist/src/components/form-helper/form-helper.d.ts:20


reset

reset(): void

根据 initialValue 重置表单项的值

Returns

void

Defined in

dist/src/components/form-helper/form-helper.d.ts:34


setField

setField(name, value): void

设置表单项控件的值. 该方法会将表单项控件的值赋值到表单数据对象中, 并更新界面.

Parameters

NameType
namestring
valueany

Returns

void

Defined in

dist/src/components/form-helper/form-helper.d.ts:40


setFields

setFields(fields): void

设置表单项集合.

Parameters

NameTypeDescription
fieldsFormModelFieldArgs<any>[]表单项的集合, 用于描述表单的结构.

Returns

void

Defined in

dist/src/components/form-helper/form-helper.d.ts:30


setRawData

setRawData(data): void

设置表单数据对象. 该方法会将表单数据对象中的值赋值到表单项控件中.

Parameters

NameType
dataRecord<string, any>

Returns

void

Defined in

dist/src/components/form-helper/form-helper.d.ts:25