API Reference
- JavaScript Reference
- Classes / FieldApi
- Classes / FormApi
- Functions / formOptions
- Functions / mergeForm
- Interfaces / FieldApiOptions
- Interfaces / FieldOptions
- Interfaces / FieldValidators
- Interfaces / FormOptions
- Interfaces / FormValidators
- Types / DeepKeys
- Types / DeepValue
- Types / AnyFieldMeta
- Types / BaseFormState
- Types / DerivedFormState
- Types / Updater
- Types / UpdaterFn
- Types / ValidationError
- Types / ValidationMeta
- Vue Reference
- Variables / Field
- Functions / useField
- Functions / useForm
- Types / FieldComponent
Field
const Field: <TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>(props) => CreateComponentPublicInstanceWithMixins<UseFieldOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta> &
| {
[key: `on${Capitalize<string>}`]: (...args) => any | undefined;
}
| {
[key: `on${Capitalize<string>}`]: (...args) => any | undefined;
}, {
}, {
}, {
}, {
}, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, PublicProps, {
}, false, {
}, {
}>;Defined in: packages/vue-form/src/useField.tsx:480
Parameters#
props#
UseFieldOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, ... 14 more ..., TParentSubmitMeta> & ({ ...; } | { ...; }) & VNodeProps & AllowedComponentProps & ComponentCustomProps
Returns#
CreateComponentPublicInstanceWithMixins<UseFieldOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta> & | { [key: `on${Capitalize<string>}`]: (...args) => any | undefined; } | { [key: `on${Capitalize<string>}`]: (...args) => any | undefined; }, { }, { }, { }, { }, ComponentOptionsMixin, ComponentOptionsMixin, EmitsOptions, PublicProps, { }, false, { }, { }>