FieldSetModel

Index

Constructors

constructor

Properties

Accessors

error
form

Methods

Constructors

constructor

new FieldSetModel(children: Children, id?: string): FieldSetModel

Overrides BasicModel.constructor
- Defined in packages/zent/src/form/formulr/models/set.ts:32
internal

Parameters
- children: Children
- Default value id: string = uniqueId('field-set-')
Returns FieldSetModel

Properties

[MODEL_ID]

[MODEL_ID]: boolean

internal

[SET_ID]

[SET_ID]: boolean

internal

childRegister$

childRegister$: Subject<string> = new Subject<string>()

childRemove$

childRemove$: Subject<string> = new Subject<string>()

Readonly children

children: Children = {} as Children

destroyOnUnmount

destroyOnUnmount: boolean = false

组件 unmount 的时候删除 model

Readonly error$

error$: BehaviorSubject<IValidateResult<Value>> = new BehaviorSubject<IMaybeError<Value>>(null)

Readonly id

id: string

initialValue

initialValue: Maybe<$FieldSetValue<Children>> = None()

internal: 初始值

owner

owner: IModel<any> | null = null

patchedValue

patchedValue: Partial<$FieldSetValue<Children>> | null = null

internal

Readonly validate$

validate$: Subject<IValidation> = new Subject<IValidation>()

internal

validators

validators: IValidators<$FieldSetValue<Children>> = []

internal: 校验规则数组

Accessors

error

get error(): IValidateResult<Value>
set error(error: IMaybeError<$FieldSetValue<Children>>): void

Inherited from FieldSetModel.error
- Defined in packages/zent/src/form/formulr/models/basic.ts:99
获取 model 上的错误信息

Returns IValidateResult<Value>
Inherited from FieldSetModel.error
- Defined in packages/zent/src/form/formulr/models/basic.ts:106
设置 model 上的错误信息

Parameters
- error: IMaybeError<$FieldSetValue<Children>>
Returns void

form

get form(): FormModel<{}>

Inherited from FieldSetModel.form
- Defined in packages/zent/src/form/formulr/models/basic.ts:51
Returns FormModel<{}>

Methods

clear

clear(): void

Implementation of IModel.clear

Overrides BasicModel.clear
- Defined in packages/zent/src/form/formulr/models/set.ts:181
清除 FieldSet 所有字段的值，同时清除 initialValue

Returns void

dirty

dirty(): boolean

Implementation of IModel.dirty

Overrides BasicModel.dirty
- Defined in packages/zent/src/form/formulr/models/set.ts:238
是否 FieldSet 上有任意字段被修改过

dirty === !pristine

Returns boolean

dispose

dispose(): void

Implementation of IModel.dispose

Overrides BasicModel.dispose
- Defined in packages/zent/src/form/formulr/models/set.ts:133
Returns void

get

get<Name>(name: Name): Children[Name] | undefined | null

- Defined in packages/zent/src/form/formulr/models/set.ts:262
返回指定字段名对应的 model

Type parameters
- Name: keyof Children
Parameters
- name: Name
  
  字段名
Returns Children[Name] | undefined | null

getPatchedValue

getPatchedValue<T>(name: string): Maybe<T>

- Defined in packages/zent/src/form/formulr/models/set.ts:69
internal

Type parameters
- T
Parameters
- name: string
Returns Maybe<T>

getRawValue

getRawValue(): $FieldSetValue<Children>

Implementation of IModel.getRawValue

Overrides BasicModel.getRawValue
- Defined in packages/zent/src/form/formulr/models/set.ts:79
获取 FieldSet 的值

Returns $FieldSetValue<Children>

getSubmitValue

getSubmitValue(): any

Implementation of IModel.getSubmitValue

Overrides BasicModel.getSubmitValue
- Defined in packages/zent/src/form/formulr/models/set.ts:94
获取 FieldSet 用于表单提交的值

Returns any

initialize

initialize(values: $FieldSetValue<Children>): void

Overrides BasicModel.initialize
- Defined in packages/zent/src/form/formulr/models/set.ts:51
初始化 FieldSet 的值，并设置 initialValue

Parameters
- values: $FieldSetValue<Children>
  
  待初始化的值
Returns void

patchValue

patchValue(value: Partial<$FieldSetValue<Children>>): void

Overrides BasicModel.patchValue
- Defined in packages/zent/src/form/formulr/models/set.ts:164
更新 FieldSet 的值

Parameters
- value: Partial<$FieldSetValue<Children>>
  
  待更新的值
Returns void

pristine

pristine(): boolean

Implementation of IModel.pristine

Overrides BasicModel.pristine
- Defined in packages/zent/src/form/formulr/models/set.ts:221
是否 FieldSet 上的所有字段都没有被修改过

Returns boolean

registerChild

registerChild(name: string, model: BasicModel<any>): void

- Defined in packages/zent/src/form/formulr/models/set.ts:111
在 FieldSet 上注册一个新的字段

Parameters
- name: string
  
  字段名
- model: BasicModel<any>
  
  字段对应的 model
Returns void

removeChild

removeChild(name: string): BasicModel<any>

- Defined in packages/zent/src/form/formulr/models/set.ts:125
在 FieldSet 上删除指定的字段

Parameters
- name: string
  
  字段名
Returns BasicModel<any>

reset

reset(): void

Implementation of IModel.reset

Overrides BasicModel.reset
- Defined in packages/zent/src/form/formulr/models/set.ts:192
重置 FieldValue 所有字段的值，如果存在 initialValue 就是用初始值，否则使用默认值

Returns void

touched

touched(): boolean

Implementation of IModel.touched

Overrides BasicModel.touched
- Defined in packages/zent/src/form/formulr/models/set.ts:246
是否 FieldSet 上有任意字段被 touch 过

Returns boolean

Protected triggerValidate

triggerValidate(option: ValidateOption): Promise<IValidateResult<Value>>

Inherited from FieldSetModel.triggerValidate
- Defined in packages/zent/src/form/formulr/models/basic.ts:79
Parameters
- option: ValidateOption
Returns Promise<IValidateResult<Value>>

valid

valid(): boolean

Implementation of IModel.valid

Overrides BasicModel.valid
- Defined in packages/zent/src/form/formulr/models/set.ts:145
是否 FieldSet 所有字段都通过了校验

Returns boolean

validate

validate(option?: ValidateOption): Promise<IMaybeError<any> | IMaybeError<any>[]>

Implementation of IModel.validate

Overrides BasicModel.validate
- Defined in packages/zent/src/form/formulr/models/set.ts:204
执行 FieldSet 的校验

Parameters
- Default value option: ValidateOption = ValidateOption.Default
  
  校验的参数
Returns Promise<IMaybeError<any> | IMaybeError<any>[]>

Type parameters

Children: UnknownFieldSetModelChildren

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

children: Children

Default value id: string = uniqueId('field-set-')

Returns FieldSetModel

Properties

[MODEL_ID]

[SET_ID]

childRegister$

childRemove$

Readonly children

destroyOnUnmount

Readonly error$

Readonly id

initialValue

owner

patchedValue

Readonly validate$

validators

Accessors

error

Returns IValidateResult<Value>

Parameters

error: IMaybeError<$FieldSetValue<Children>>

Returns void

form

Returns FormModel<{}>

Methods

clear

Returns void

dirty

Returns boolean

dispose

Returns void

get

Type parameters

Name: keyof Children

Parameters

name: Name

Returns Children[Name] | undefined | null

getPatchedValue

Type parameters

T

Parameters

name: string

Returns Maybe<T>

getRawValue

Returns $FieldSetValue<Children>

getSubmitValue

Returns any

initialize

Parameters

values: $FieldSetValue<Children>

Returns void

patchValue

Parameters

value: Partial<$FieldSetValue<Children>>

Returns void

pristine

Returns boolean

registerChild

Parameters

name: string

model: BasicModel<any>

Returns void

removeChild

Parameters

name: string

Returns BasicModel<any>

reset