FieldGroupOptions

Interface: FieldGroupOptions<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnServer, TSubmitMeta>

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

An object representing the options for a field group.

Type Parameters

TFormData

TFieldGroupData

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

TOnMount extends undefined | FormValidateOrFn<TFormData>

TOnChange extends undefined | FormValidateOrFn<TFormData>

TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnBlur extends undefined | FormValidateOrFn<TFormData>

TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnSubmit extends undefined | FormValidateOrFn<TFormData>

TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>

TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>

TSubmitMeta = never

Properties

defaultValues?

ts
optional defaultValues: TFieldGroupData;
optional defaultValues: TFieldGroupData;

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

The expected subsetValues that the form must provide.


fields

ts
fields: TFields;
fields: TFields;

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

The path to the field group data.


form

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

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


onSubmitMeta?

ts
optional onSubmitMeta: TSubmitMeta;
optional onSubmitMeta: TSubmitMeta;

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

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

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.