Skip to content

Latest commit

 

History

History
86 lines (49 loc) · 2.75 KB

vueformapi.md

File metadata and controls

86 lines (49 loc) · 2.75 KB
id title
VueFormApi
VueFormApi

Interface: VueFormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>

Defined in: packages/vue-form/src/useForm.tsx:115

Type Parameters

TParentData

TFormOnMount extends undefined | FormValidateOrFn<TParentData>

TFormOnChange extends undefined | FormValidateOrFn<TParentData>

TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>

TFormOnBlur extends undefined | FormValidateOrFn<TParentData>

TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>

TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>

TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>

TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>

TSubmitMeta

Properties

Field

Field: FieldComponent<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>;

Defined in: packages/vue-form/src/useForm.tsx:127


Subscribe

Subscribe: SubscribeComponent<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer>;

Defined in: packages/vue-form/src/useForm.tsx:182


useField

useField: UseField<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer, TSubmitMeta>;

Defined in: packages/vue-form/src/useForm.tsx:139


useStore()

useStore: <TSelected>(selector?) => Readonly<Ref<TSelected, TSelected>>;

Defined in: packages/vue-form/src/useForm.tsx:151

Type Parameters

TSelected = FormState<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnServer>

Parameters

selector?

(state) => TSelected

Returns

Readonly<Ref<TSelected, TSelected>>