Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

UseField.md

48 lines1.2 KB

Type Alias: UseField()<TParentData, TFormValidator>

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

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

object

api

api: FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData> & VueFieldApi<TParentData, TFormValidator>;

state

state: Readonly<Ref<FieldApi<TParentData, TName, TFieldValidator, TFormValidator, TData>["state"]>>;

Defined in

packages/vue-form/src/useField.tsx:17