Function: useField()

function useField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>(opts): object;

function useField<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>(opts): object;

Defined in: packages/vue-form/src/useField.tsx:189

Type Parameters

TParentData

TName

TName extends string

TData

TOnMount

TOnMount extends FieldValidateOrFn<TParentData, TName, TData> | undefined

TOnChange

TOnChange extends FieldValidateOrFn<TParentData, TName, TData> | undefined

TOnChangeAsync

TOnChangeAsync extends FieldAsyncValidateOrFn<TParentData, TName, TData> | undefined

TOnBlur

TOnBlur extends FieldValidateOrFn<TParentData, TName, TData> | undefined

TOnBlurAsync

TOnBlurAsync extends FieldAsyncValidateOrFn<TParentData, TName, TData> | undefined

TOnSubmit

TOnSubmit extends FieldValidateOrFn<TParentData, TName, TData> | undefined

TOnSubmitAsync

TOnSubmitAsync extends FieldAsyncValidateOrFn<TParentData, TName, TData> | undefined

TOnDynamic

TOnDynamic extends FieldValidateOrFn<TParentData, TName, TData> | undefined

TOnDynamicAsync

TOnDynamicAsync extends FieldAsyncValidateOrFn<TParentData, TName, TData> | undefined

TFormOnMount

TFormOnMount extends FormValidateOrFn<TParentData> | undefined

TFormOnChange

TFormOnChange extends FormValidateOrFn<TParentData> | undefined

TFormOnChangeAsync

TFormOnChangeAsync extends FormAsyncValidateOrFn<TParentData> | undefined

TFormOnBlur

TFormOnBlur extends FormValidateOrFn<TParentData> | undefined

TFormOnBlurAsync

TFormOnBlurAsync extends FormAsyncValidateOrFn<TParentData> | undefined

TFormOnSubmit

TFormOnSubmit extends FormValidateOrFn<TParentData> | undefined

TFormOnSubmitAsync

TFormOnSubmitAsync extends FormAsyncValidateOrFn<TParentData> | undefined

TFormOnDynamic

TFormOnDynamic extends FormValidateOrFn<TParentData> | undefined

TFormOnDynamicAsync

TFormOnDynamicAsync extends FormAsyncValidateOrFn<TParentData> | undefined

TFormOnServer

TFormOnServer extends FormAsyncValidateOrFn<TParentData> | undefined

TParentSubmitMeta

Parameters

opts

UseFieldOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>

Returns

object

api

readonly api: FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta> = extendedFieldApi.value;

readonly api: FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta> = extendedFieldApi.value;

state

readonly state: object = fieldState.value;

readonly state: object = fieldState.value;

state.meta

meta: object;

meta: object;

state.meta.errorMap

errorMap: ValidationErrorMap<UnwrapFieldValidateOrFn<TName, TOnMount, TFormOnMount>, UnwrapFieldValidateOrFn<TName, TOnChange, TFormOnChange>, UnwrapFieldAsyncValidateOrFn<TName, TOnChangeAsync, TFormOnChangeAsync>, UnwrapFieldValidateOrFn<TName, TOnBlur, TFormOnBlur>, UnwrapFieldAsyncValidateOrFn<TName, TOnBlurAsync, TFormOnBlurAsync>, UnwrapFieldValidateOrFn<TName, TOnSubmit, TFormOnSubmit>, UnwrapFieldAsyncValidateOrFn<TName, TOnSubmitAsync, TFormOnSubmitAsync>, UnwrapFieldValidateOrFn<TName, TOnDynamic, TFormOnDynamic>, UnwrapFieldAsyncValidateOrFn<TName, TOnDynamicAsync, TFormOnDynamicAsync>>;

errorMap: ValidationErrorMap<UnwrapFieldValidateOrFn<TName, TOnMount, TFormOnMount>, UnwrapFieldValidateOrFn<TName, TOnChange, TFormOnChange>, UnwrapFieldAsyncValidateOrFn<TName, TOnChangeAsync, TFormOnChangeAsync>, UnwrapFieldValidateOrFn<TName, TOnBlur, TFormOnBlur>, UnwrapFieldAsyncValidateOrFn<TName, TOnBlurAsync, TFormOnBlurAsync>, UnwrapFieldValidateOrFn<TName, TOnSubmit, TFormOnSubmit>, UnwrapFieldAsyncValidateOrFn<TName, TOnSubmitAsync, TFormOnSubmitAsync>, UnwrapFieldValidateOrFn<TName, TOnDynamic, TFormOnDynamic>, UnwrapFieldAsyncValidateOrFn<TName, TOnDynamicAsync, TFormOnDynamicAsync>>;

state.meta.errorSourceMap

errorSourceMap: ValidationErrorMapSource;

errorSourceMap: ValidationErrorMapSource;

state.meta.isBlurred

isBlurred: boolean;

isBlurred: boolean;

state.meta.isDirty

isDirty: boolean;

isDirty: boolean;

state.meta.isTouched

isTouched: boolean;

isTouched: boolean;

state.meta.isValidating

isValidating: boolean;

isValidating: boolean;

state.value

value: TData;

value: TData;

useField

Function: useField()#

Type Parameters#

TParentData#

TName#

TData#

TOnMount#

TOnChange#

TOnChangeAsync#

TOnBlur#

TOnBlurAsync#

TOnSubmit#

TOnSubmitAsync#

TOnDynamic#

TOnDynamicAsync#

TFormOnMount#

TFormOnChange#

TFormOnChangeAsync#

TFormOnBlur#

TFormOnBlurAsync#

TFormOnSubmit#

TFormOnSubmitAsync#

TFormOnDynamic#

TFormOnDynamicAsync#

TFormOnServer#

TParentSubmitMeta#

Parameters#

opts#

Returns#

api#

state#

state.meta#

state.meta.errorMap#

state.meta.errorSourceMap#

state.meta.isBlurred#

state.meta.isDirty#

state.meta.isTouched#

state.meta.isValidating#

state.value#