FieldGroupOptions

Defined in: packages/form-core/src/FieldGroupApi.ts:51

An object representing the options for a field group.

Type Parameters#

TFormData#

TFormData

TFieldGroupData#

TFieldGroupData

TFields#

TFields extends | DeepKeysOfType<TFormData, TFieldGroupData | null | undefined> | FieldsMap<TFormData, TFieldGroupData>

TOnMount#

TOnMount extends undefined | FormValidateOrFn<TFormData>

TOnChange#

TOnChange extends undefined | FormValidateOrFn<TFormData>

TOnChangeAsync#

TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnBlur#

TOnBlur extends undefined | FormValidateOrFn<TFormData>

TOnBlurAsync#

TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnSubmit#

TOnSubmit extends undefined | FormValidateOrFn<TFormData>

TOnSubmitAsync#

TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnDynamic#

TOnDynamic extends undefined | FormValidateOrFn<TFormData>

TOnDynamicAsync#

TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnServer#

TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>

TSubmitMeta#

TSubmitMeta = never

Properties#

defaultValues?#

optional defaultValues: TFieldGroupData;

Defined in: packages/form-core/src/FieldGroupApi.ts:107

The expected subsetValues that the form must provide.

fields#

fields: TFields;

Defined in: packages/form-core/src/FieldGroupApi.ts:103

The path to the field group data.

form#

form: 
  | FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
| FieldGroupApi<any, TFormData, any, any, any, any, any, any, any, any, any, any, any, TSubmitMeta>;

Defined in: packages/form-core/src/FieldGroupApi.ts:69

onSubmitMeta?#

optional onSubmitMeta: TSubmitMeta;

Defined in: packages/form-core/src/FieldGroupApi.ts:111

onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props