useField

Creates a reactive field store for a specific field within a form store.

const field = useField<TSchema, TFieldPath>(form, config);

Generics

• TSchema extends FormSchema
• TFieldPath extends RequiredPath

Parameters

• form MaybeRefOrGetter<FormStore<TSchema>>
• config MaybeRefOrGetter<UseFieldConfig<TSchema, TFieldPath>>

Explanation

With useField you create a reactive field store for a specific field path within your form. The field store provides reactive access to the field's input value, validation errors, touched state, and more. It also includes a props object that you can bind to an HTML input or textarea element with v-bind to automatically handle user interactions like focus, change, and blur. The value itself is bound with v-model="field.input".

Returns

• field FieldStore<TSchema, TFieldPath>

Related

The following APIs can be combined with useField.

Composables

• useForm,
• useFieldArray

Components

• Field,
• FieldArray,
• Form

Methods

• focus,
• getErrors,
• getInput,
• setErrors,
• setInput,
• validate