Interface: Field
Field with the form data.
Properties
clear()
clear: () =>
void
Clears the data in the field.
Returns
void
dispose()
dispose: () =>
void
Releases allocated resources, must be used when destroying an object instance.
Returns
void
error?
optionalerror:string
Contains a field validation error if the field data is not valid.
errors?
optionalerrors:Record<string,unknown>[] |Record<string,unknown>
Contains a field validation errors if the field provides multiple errors (i.e. field is template). Contains an array of field validation errors if the field contains an array of components.
fieldType
fieldType:
FieldType
The field type.
getValidationResult()
getValidationResult: () =>
Promise<ValidationMessages[] |ValidationMessages>
Returns the validation results without triggering an events and changing the state of the form.
Returns
Promise<ValidationMessages[] | ValidationMessages>
the ValidationMessages validation results.
init()
init: () =>
void
Initializes the value of the field.
Returns
void
reset()
reset: () =>
void
Sets the field to its default value.
Returns
void
setError()
setError: (
error) =>void
Sets the error value.
Parameters
error
unknown
The error value to be set.
Returns
void
setTouched()
setTouched: () =>
void
Marks the field as touched.
Returns
void
setValue()
setValue: (
value) =>void
Sets the value of the field.
Parameters
value
unknown
the value.
Returns
void
storeDataInParentForm?
optionalstoreDataInParentForm:boolean
Flag, false if nested form data show as nested object, true otherwise.
touched
touched:
boolean
Flag, true, if the field is marked as touched.
validate()
validate: () =>
Promise<void>
Validates the field value.
Returns
Promise<void>
value
value:
unknown
Value of the field.
valued
valued:
string
The name of the component property that contains the field value.