Source: https://tanstack.com/form/latest/docs/reference/interfaces/fieldgroupoptions

TanStack

Form v1v1

Search...

+ K

Auto

Log In

TanStack StartRC

Docs Examples GitHub Contributors

TanStack Router

Docs Examples GitHub Contributors

TanStack Query

Docs Examples GitHub Contributors

TanStack Table

Docs Examples Github Contributors

TanStack Formnew

Docs Examples Github Contributors

TanStack DBbeta

Docs Github Contributors

TanStack Virtual

Docs Examples Github Contributors

TanStack Paceralpha

Docs Examples Github Contributors

TanStack Storealpha

Docs Examples Github Contributors

TanStack Devtoolsalpha

Docs Github Contributors

More Libraries

Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide

Documentation

Framework

React

Version

Latest

Search...

+ K

Menu

• Home

• Frameworks

• Contributors

• Community Resources

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Installation
  
  core

• Philosophy
  
  core

• Comparison
  
  core

• TypeScript
  
  core

• Quick Start
  
  react

Guides

• Basic Concepts
  
  react

• Form Validation
  
  react

• Dynamic Validation
  
  react

• Async Initial Values
  
  react

• Arrays
  
  react

• Linked Fields
  
  react

• Reactivity
  
  react

• Listeners
  
  react

• Custom Errors
  
  react

• Submission Handling
  
  react

• UI Libraries
  
  react

• Focus Management
  
  react

• Form Composition
  
  react

• React Native
  
  react

• SSR/TanStack Start/Next.js
  
  react

• Debugging
  
  react

• Devtools
  
  react

API Reference

• JavaScript Reference
  
  core

• Classes / FieldApi
  
  core

• Classes / FormApi
  
  core

• Functions / formOptions
  
  core

• Functions / mergeForm
  
  core

• Interfaces / FieldApiOptions
  
  core

• Interfaces / FieldOptions
  
  core

• Interfaces / FieldValidators
  
  core

• Interfaces / FormOptions
  
  core

• Interfaces / FormValidators
  
  core

• Types / DeepKeys
  
  core

• Types / DeepValue
  
  core

• Types / FieldInfo
  
  core

• Types / FieldMeta
  
  core

• Types / FieldState
  
  core

• Types / BaseFormState
  
  core

• Types / DerivedFormState
  
  core

• Types / Updater
  
  core

• Types / UpdaterFn
  
  core

• Types / ValidationError
  
  core

• Types / ValidationMeta
  
  core

• React Reference
  
  react

• Functions / Field
  
  react

• Functions / useField
  
  react

• Functions / useForm
  
  react

• Functions / useTransform
  
  react

• Types / FieldComponent
  
  react

• Types / UseField
  
  react

Examples

• Simple
  
  react

• Arrays
  
  react

• Form Composition
  
  react

• Dynamic Validation
  
  react

• TanStack Query Integration
  
  react

• Standard Schema
  
  react

• TanStack Start
  
  react

• Next Server Actions
  
  react

• Remix
  
  react

• UI Libraries
  
  react

• Field Errors From Form Validators
  
  react

• Devtools
  
  react

Framework

React

Version

Latest

Menu

• Home

• Frameworks

• Contributors

• Community Resources

• GitHub

• Discord

Getting Started

• Overview
  
  core

• Installation
  
  core

• Philosophy
  
  core

• Comparison
  
  core

• TypeScript
  
  core

• Quick Start
  
  react

Guides

• Basic Concepts
  
  react

• Form Validation
  
  react

• Dynamic Validation
  
  react

• Async Initial Values
  
  react

• Arrays
  
  react

• Linked Fields
  
  react

• Reactivity
  
  react

• Listeners
  
  react

• Custom Errors
  
  react

• Submission Handling
  
  react

• UI Libraries
  
  react

• Focus Management
  
  react

• Form Composition
  
  react

• React Native
  
  react

• SSR/TanStack Start/Next.js
  
  react

• Debugging
  
  react

• Devtools
  
  react

API Reference

• JavaScript Reference
  
  core

• Classes / FieldApi
  
  core

• Classes / FormApi
  
  core

• Functions / formOptions
  
  core

• Functions / mergeForm
  
  core

• Interfaces / FieldApiOptions
  
  core

• Interfaces / FieldOptions
  
  core

• Interfaces / FieldValidators
  
  core

• Interfaces / FormOptions
  
  core

• Interfaces / FormValidators
  
  core

• Types / DeepKeys
  
  core

• Types / DeepValue
  
  core

• Types / FieldInfo
  
  core

• Types / FieldMeta
  
  core

• Types / FieldState
  
  core

• Types / BaseFormState
  
  core

• Types / DerivedFormState
  
  core

• Types / Updater
  
  core

• Types / UpdaterFn
  
  core

• Types / ValidationError
  
  core

• Types / ValidationMeta
  
  core

• React Reference
  
  react

• Functions / Field
  
  react

• Functions / useField
  
  react

• Functions / useForm
  
  react

• Functions / useTransform
  
  react

• Types / FieldComponent
  
  react

• Types / UseField
  
  react

Examples

• Simple
  
  react

• Arrays
  
  react

• Form Composition
  
  react

• Dynamic Validation
  
  react

• TanStack Query Integration
  
  react

• Standard Schema
  
  react

• TanStack Start
  
  react

• Next Server Actions
  
  react

• Remix
  
  react

• UI Libraries
  
  react

• Field Errors From Form Validators
  
  react

• Devtools
  
  react

On this page

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

• Type Parameters

• Properties

• defaultValues?

• fields

• form

• onSubmitMeta?

FieldGroupOptions

Copy Markdown

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

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

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>

• TOnDynamic extends undefined | FormValidateOrFn<TFormData>

• TOnDynamicAsync 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:105

The expected subsetValues that the form must provide.

---

### fields

ts

fields: TFields;


fields: TFields;

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

The path to the field group data.

---

### form

ts

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>;


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:67

---

### onSubmitMeta?

ts

optional onSubmitMeta: TSubmitMeta;


optional onSubmitMeta: TSubmitMeta;

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

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

Edit on GitHub

Home

Partners Become a Partner