UseField

Type Alias: UseField()<TParentData, TFormValidator>

ts
type UseField<TParentData, TFormValidator>: <TName, TFieldValidator, TData>(opts) => FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;
type UseField<TParentData, TFormValidator>: <TName, TFieldValidator, TData>(opts) => FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>;

A type representing a hook for using a field in a form with the given form data type.

A function that takes an optional object with a name property and field options, and returns a FieldApi instance for the specified field.

Type Parameters

TParentData

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

Type Parameters

TName extends DeepKeys<TParentData>

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

TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>

Parameters

opts: Omit<UseFieldOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>, "form">

Returns

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

Defined in

useField.tsx:26

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.