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

useField.md

46 lines1.1 KB

Function: useField()

function useField<TParentData, TName, TFieldValidator, TFormValidator, TData>(opts): object

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>

Returns

object

api

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

state

readonly state: Readonly<Ref<FieldState<TData>>> = fieldState;

Defined in

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