FieldArrayModel

Type parameters

Item
Child: IModel<Item>

Hierarchy

BasicModel<keyof Item[]>
- FieldArrayModel

Implements

IModel<keyof Item[]>

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new FieldArrayModel(childBuilder: BasicBuilder<Item, Child> | null, defaultValue: keyof Item[]): FieldArrayModel

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

Parameters
- childBuilder: BasicBuilder<Item, Child> | null
- defaultValue: keyof Item[]
Returns FieldArrayModel

Properties

[FIELD_ARRAY_ID]

[FIELD_ARRAY_ID]: boolean

internal

[MODEL_ID]

[MODEL_ID]: boolean

internal

Private Readonly childFactory

childFactory: (defaultValue: Item) => Child

Type declaration

- (defaultValue: Item): Child
- Parameters
  - defaultValue: Item
  Returns Child

Readonly children$

children$: BehaviorSubject<Child[]>

Private Readonly defaultValue

defaultValue: keyof Item[]

destroyOnUnmount

destroyOnUnmount: boolean = false

组件 unmount 的时候删除 model

Readonly error$

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

Readonly id

id: string

initialValue

initialValue: Maybe<keyof Item[]> = None()

internal: 初始值

owner

owner: IModel<any> | null = null

Readonly validate$

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

internal

validators

validators: IValidators<keyof Item[]> = []

internal: 校验规则数组

Accessors

children

get children(): Child[]

- Defined in packages/zent/src/form/formulr/models/array.ts:72
获取 FieldArray 内的所有 model

Returns Child[]

error

get error(): IValidateResult<Value>
set error(error: IMaybeError<keyof Item[]>): 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<keyof Item[]>
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/array.ts:63
清除 FieldArray 的初始值，并将当前值设置为默认值

Returns void

dirty

dirty(): boolean

Implementation of IModel.dirty

Overrides BasicModel.dirty
- Defined in packages/zent/src/form/formulr/models/array.ts:274
是否 FieldArray 中任意元素有过修改

dirty === !pristine

Returns boolean

dispose

dispose(): void

Implementation of IModel.dispose

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

getRawValue

getRawValue()

Implementation of IModel.getRawValue

Overrides BasicModel.getRawValue
- Defined in packages/zent/src/form/formulr/models/array.ts:101
获取 FieldArray 内的原始值

getSubmitValue

getSubmitValue()

Implementation of IModel.getSubmitValue

Overrides BasicModel.getSubmitValue
- Defined in packages/zent/src/form/formulr/models/array.ts:116
获取 FieldArray 的用于表单提交的值，和原始值可能不一致

initialize

initialize(values: Item[]): void

Overrides BasicModel.initialize
- Defined in packages/zent/src/form/formulr/models/array.ts:161
初始化 FieldArray 的值，同时设置 initialValue

Parameters
- values: Item[]
  
  要设置为初始化值的值
Returns void

patchValue

patchValue(value: Item[]): void

Overrides BasicModel.patchValue
- Defined in packages/zent/src/form/formulr/models/array.ts:132
修改 FieldArray 的值

Parameters
- value: Item[]
  
  要修改的值
Returns void

pop

pop(): Child

- Defined in packages/zent/src/form/formulr/models/array.ts:181
删除 FieldArray 最后的一个元素

Returns Child

pristine

pristine(): boolean

Implementation of IModel.pristine

Overrides BasicModel.pristine
- Defined in packages/zent/src/form/formulr/models/array.ts:258
是否 FieldArray 所有元素都没有修改过

Returns boolean

push

push(...items: Item[]): void

- Defined in packages/zent/src/form/formulr/models/array.ts:171
添加一批元素到 FieldArray 的末尾

Parameters
- Rest ...items: Item[]
  
  待添加的值
Returns void

reset

reset(): void

Implementation of IModel.reset

Overrides BasicModel.reset
- Defined in packages/zent/src/form/formulr/models/array.ts:53
重置 FieldArray 为初始值，初始值通过 initialize 设置；如果初始值不存在就使用默认值

Returns void

shift

shift(): Child

- Defined in packages/zent/src/form/formulr/models/array.ts:194
删除 FieldArray 第一个元素

Returns Child

splice

splice(start: number, deleteCount?: number, ...items: keyof Item[]): Child[]

- Defined in packages/zent/src/form/formulr/models/array.ts:221
在 FieldArray 的指定位置删除指定数量的元素，并添加指定的新元素

Parameters
- start: number
  
  开始删除的元素位置
- Default value deleteCount: number = 0
  
  删除的元素个数
- Rest ...items: keyof Item[]
  
  待添加的元素值
Returns Child[]

touched

touched(): boolean

Implementation of IModel.touched

Overrides BasicModel.touched
- Defined in packages/zent/src/form/formulr/models/array.ts:281
是否 FieldArray 任意元素被 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>>

unshift

unshift(...items: Item[]): void

- Defined in packages/zent/src/form/formulr/models/array.ts:208
在 FieldArray 开头添加值

Parameters
- Rest ...items: Item[]
  
  待添加的值·
Returns void

valid

valid(): boolean

Implementation of IModel.valid

Overrides BasicModel.valid
- Defined in packages/zent/src/form/formulr/models/array.ts:79
FieldArray 内所有 model 是否都通过了校验

Returns boolean

validate

validate(option?: ValidateOption): Promise<any>

Implementation of IModel.validate

Overrides BasicModel.validate
- Defined in packages/zent/src/form/formulr/models/array.ts:242
执行 FieldArray 的校验

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

Type parameters

Item

Child: IModel<Item>

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

childBuilder: BasicBuilder<Item, Child> | null

defaultValue: keyof Item[]

Returns FieldArrayModel

Properties

[FIELD_ARRAY_ID]

[MODEL_ID]

Private Readonly childFactory

Type declaration

Parameters

defaultValue: Item

Returns Child

Readonly children$

Private Readonly defaultValue

destroyOnUnmount

Readonly error$

Readonly id

initialValue

owner

Readonly validate$

validators

Accessors

children

Returns Child[]

error

Returns IValidateResult<Value>

Parameters

error: IMaybeError<keyof Item[]>

Returns void

form

Returns FormModel<{}>

Methods

clear

Returns void

dirty

Returns boolean

dispose

Returns void

getRawValue

getSubmitValue

initialize

Parameters

values: Item[]

Returns void

patchValue

Parameters

value: Item[]

Returns void

pop

Returns Child

pristine

Returns boolean

push

Parameters

Rest ...items: Item[]

Returns void

reset

Returns void

shift

Returns Child

splice

Parameters

start: number

Default value deleteCount: number = 0

Rest ...items: keyof Item[]

Returns Child[]

touched

Returns boolean