useField

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

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

Generics

• TSchema extends Schema
• TFieldPath extends RequiredPath

Parameters

• form MaybeGetter<FormStore<TSchema>>
• config MaybeGetter<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 spread onto an HTML input or textarea element to automatically handle user interactions like focus, blur, and input events.

Returns

• field FieldStore<TSchema, TFieldPath>

Related

The following APIs can be combined with useField.

Runes

• createForm,
• useFieldArray

Components

• Field,
• FieldArray,
• Form

Methods

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