Skip to content
On this page

EzFormItem Component API

Props

NameDescriptionType
nameForm item's name path to sync dataNamePath
formItemA FormItemInstance to control form item from outsideFormItemInstance
labelForm item's labelstring
defaultValueForm item's default valueany
valuePropNameInput's value prop name to pass data tostring
changeEventPropNameInput's change event prop name to listen tostring
blurEventPropNameInput's blur event prop name to listen tostring
getValueFromChangeEventFunction to get data from change event(event:any) => any
valueTransformerFunction to transform data received from form's data to pass to input and backwardsFormItemValueTransformer
autoBindingAuto binding value and event to inputboolean
inputNodeIndexIndex of input in node list to binding data to. Default: 0number
requiredMarkShow form item's required markboolean | string
rulesValidation rulesRule
validateTriggerConfig field validate triggerValidateTrigger
validateFirstValidate first rule of form item onlyValidateTrigger
noStyleHide label and errorboolean
colonShow label colonboolean

Events

NameDescriptionType
onChangeTrigger after form item data changed(values: any) => void

Scoped slots

Slot Default

NameDescriptionType
valueTransformed value of form item, to pass to input.any
rawValueRaw value of form item.any
handleChangeHandle change function, to pass to your input's change event.(event: any) => void
formA form instanceFormInstance
errorForm item errorValidateError

Slot Errors

NameDescriptionType
errorsErrors of form item.ValidateError | undefined
formFormInstance
formItemFormItemInstance

EzForm