Function: useFieldValidation()
API / @xmachines/play-vue / useFieldValidation
function useFieldValidation(path, config?): object;Defined in: @xmachines/json-render-vue
Composable to get validation state for a field.
path and config can be plain values, refs or getters. A plain path
stays as it is. A getter or a ref follows its value: a new path or a new
config of a mounted field registers it again. A component in a keyed row
passes a getter, such as () => props.bindings?.value, so the field
follows the bound path of now after a move, and a binding that a later
spec adds.
Parameters
| Parameter | Type |
|---|---|
path | MaybeRefOrGetter<string | undefined> |
config? | MaybeRefOrGetter<ValidationConfig | undefined> |
Returns
object
| Name | Type | Defined in |
|---|---|---|
clear() | () => void | - |
errors | ComputedRef<string[]> | - |
isValid | ComputedRef<boolean> | - |
state | ComputedRef<FieldValidationState> | - |
touch() | () => void | - |
validate() | () => ValidationResult | - |