usefield.md

id	title
useField	useField

Function: useField()

function useField<TParentData, TName, TFieldValidator, TFormValidator, TData>(opts): FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData> & ReactFieldApi<TParentData, TFormValidator>

Defined in: packages/react-form/src/useField.tsx:50

A hook for managing a field in a form.

Type Parameters

• TParentData

• TName extends string | number

• TFieldValidator extends | undefined | Validator<DeepValue<TParentData, TName>, unknown> = undefined

• TFormValidator extends undefined | Validator<TParentData, unknown> = undefined

• TData = DeepValue<TParentData, TName>

Parameters

opts

UseFieldOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>

An object with field options.

Returns

FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData> & ReactFieldApi<TParentData, TFormValidator>

The FieldApi instance for the specified field.