On this page

EzFormList Component API

Props

Name	Description	Type
name	Form list's name path to sync data	`NamePath`
formList	FormList Instance to controls this form list from outside.	`FormListInstance`
label	Form list's label	`string`
defaultValue	Form list's default value	`any[]`
valuePropName	Input's value prop name to pass data to	`string`
changeEventPropName	Input's change event prop name to listen to	`string`
blurEventPropName	Input's blur event prop name to listen to	`string`
getValueFromChangeEvent	Function to get data from change event	`(event:any) => any`
valueTransformer	Function to transform data received from form's data to pass to input and backwards	`FormItemValueTransformer`
autoBinding	Auto binding value and event to input	`boolean`
inputNodeIndex	Index of input in node list to binding data to. Default: 0	`number`
requiredMark	Show form list's required mark	`boolean \| string`
rules	Validation rules	`Rule`
validateTrigger	Config field validate trigger	`ValidateTrigger`
validateFirst	Validate first rule of form list only	`ValidateTrigger`
noStyle	Hide label and error	`boolean`
colon	Show label colon	`boolean`

Events

Name	Description	Type
onChange	Trigger after form list data changed	`(values: any) => void`

Scoped slots

Slot Default

Name	Description	Type
value	Value of form list	`Array<any>`
length	Length of form list's value	`number`
fields	List generated fields data to pass to form item	`FormListField[]`
getNamePath	Function to generate name path of form item in form list	`(index: number, namePath: string) => Array<string\|number>`
errors	List error of form list	`Array`
getErrors	Function to get list array of form list's item	`(index: number) => Array`
hasError	Function to check if form item has error if	`(index: number) => boolean`
add	Function to add item to form list	`(value?: any) => void`
insert	Function to insert item to an index of form list	`(index:number; value?: any) => void`
unshift	Function to add item to first index of form list	`(value?: any) => void`
pop	Function to remove last item of form list	`() => void`
shift	Function to remove first item of form list	`() => void`
remove	Function to remove item from form list by index	`(index: number) => void`
removeByKey	Function to remove item from list by custom key	`(key: string, value: any) => void`
swap	Function to swap two item by index	`(firstIndex: number, secondIndex: number) => void`
replace	Function to replace an item of list with other value	`(index: number, value: any) => void`
move	Function to move an item of list to other index	`(fromIndex: number, toIndex: number) => void`
form	Form's utility functions and data	`FormInstance`

Slot Errors

Name	Description	Type
errors	Errors of form list itself, not include it's fields errors.	`ValidateError \| undefined`
form		`FormInstance`
formList		`FormListInstance`