Function: useFieldGroup()#

function useFieldGroup<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TComponents, TFormComponents, TSubmitMeta>(opts): AppFieldExtendedReactFieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta, TComponents, TFormComponents>;

Defined in: packages/react-form/src/useFieldGroup.tsx:96

Type Parameters#

TFormData#

TFormData

TFieldGroupData#

TFieldGroupData

TFields#

TFields extends | string | { [K in string | number | symbol]: DeepKeysOfType\ }

TOnMount#

TOnMount extends FormValidateOrFn\<`TFormData`\> | undefined

TOnChange#

TOnChange extends FormValidateOrFn\<`TFormData`\> | undefined

TOnChangeAsync#

TOnChangeAsync extends FormAsyncValidateOrFn\<`TFormData`\> | undefined

TOnBlur#

TOnBlur extends FormValidateOrFn\<`TFormData`\> | undefined

TOnBlurAsync#

TOnBlurAsync extends FormAsyncValidateOrFn\<`TFormData`\> | undefined

TOnSubmit#

TOnSubmit extends FormValidateOrFn\<`TFormData`\> | undefined

TOnSubmitAsync#

TOnSubmitAsync extends FormAsyncValidateOrFn\<`TFormData`\> | undefined

TOnDynamic#

TOnDynamic extends FormValidateOrFn\<`TFormData`\> | undefined

TOnDynamicAsync#

TOnDynamicAsync extends FormAsyncValidateOrFn\<`TFormData`\> | undefined

TOnServer#

TOnServer extends FormAsyncValidateOrFn\<`TFormData`\> | undefined

TComponents#

TComponents extends Record\<`string`, `ComponentType`\<`any`\>>

TFormComponents#

TFormComponents extends Record\<`string`, `ComponentType`\<`any`\>>

TSubmitMeta#

TSubmitMeta = never

Parameters#

opts#

defaultValues?#

TFieldGroupData

fields#

TFields

form#

| AppFieldExtendedReactFormApi\<`TFormData`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`\> | AppFieldExtendedReactFieldGroupApi\<`unknown`, `TFormData`, `string` \| `FieldsMap`\<`unknown`, `TFormData`\>, any, any, any, any, any, any, any, any, any, any, TSubmitMeta, TComponents, TFormComponents>

formComponents#

TFormComponents

onSubmitMeta?#

TSubmitMeta

Returns#

AppFieldExtendedReactFieldGroupApi\<`TFormData`, `TFieldGroupData`, `TFields`, `TOnMount`, `TOnChange`, `TOnChangeAsync`, `TOnBlur`, `TOnBlurAsync`, `TOnSubmit`, `TOnSubmitAsync`, `TOnDynamic`, `TOnDynamicAsync`, `TOnServer`, `TSubmitMeta`, `TComponents`, `TFormComponents`\>