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

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: FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>

• Extends

• Type Parameters

• Properties

• asyncAlways?

• Inherited from

• asyncDebounceMs?

• Inherited from

• defaultMeta?

• Inherited from

• defaultValue?

• Inherited from

• disableErrorFlat?

• Inherited from

• form

• listeners?

• Inherited from

• name

• Inherited from

• validators?

• Inherited from

FieldApiOptions

Copy Markdown

Interface: FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>
===================================================================================================================================================================================================================================================================================================================================================================

Defined in: packages/form-core/src/FieldApi.ts:486

An object type representing the required options for the FieldApi class.

Extends
-------

• FieldOptions <TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>

Type Parameters
---------------

• TParentData

• TName extends DeepKeys <TParentData>

• TData extends DeepValue <TParentData, TName>

• TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>

• TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>

• TOnChangeAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

• TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>

• TOnBlurAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

• TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>

• TOnSubmitAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

• TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>

• TOnDynamicAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

• TFormOnMount extends undefined | FormValidateOrFn<TParentData>

• TFormOnChange extends undefined | FormValidateOrFn<TParentData>

• TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnBlur extends undefined | FormValidateOrFn<TParentData>

• TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>

• TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>

• TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>

• TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>

• TParentSubmitMeta

Properties
---------- ### asyncAlways?

ts

optional asyncAlways: boolean;


optional asyncAlways: boolean;

Defined in: packages/form-core/src/FieldApi.ts:427

If true, always run async validation, even if there are errors emitted during synchronous validation.

#### Inherited from

FieldOptions .asyncAlways

---

### asyncDebounceMs?

ts

optional asyncDebounceMs: number;


optional asyncDebounceMs: number;

Defined in: packages/form-core/src/FieldApi.ts:423

The default time to debounce async validation if there is not a more specific debounce time passed.

#### Inherited from

FieldOptions .asyncDebounceMs

---

### defaultMeta?

ts

optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;


optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;

Defined in: packages/form-core/src/FieldApi.ts:448

An optional object with default metadata for the field.

#### Inherited from

FieldOptions .defaultMeta

---

### defaultValue?

ts

optional defaultValue: NoInfer<TData>;


optional defaultValue: NoInfer<TData>;

Defined in: packages/form-core/src/FieldApi.ts:419

An optional default value for the field.

#### Inherited from

FieldOptions .defaultValue

---

### disableErrorFlat?

ts

optional disableErrorFlat: boolean;


optional disableErrorFlat: boolean;

Defined in: packages/form-core/src/FieldApi.ts:480

Disable the flat(1) operation on field.errors. This is useful if you want to keep the error structure as is. Not suggested for most use-cases.

#### Inherited from

FieldOptions .disableErrorFlat

---

### form

ts

form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;


form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;

Defined in: packages/form-core/src/FieldApi.ts:550

---

### listeners?

ts

optional listeners: FieldListeners<TParentData, TName, TData>;


optional listeners: FieldListeners<TParentData, TName, TData>;

Defined in: packages/form-core/src/FieldApi.ts:476

A list of listeners which attach to the corresponding events

#### Inherited from

FieldOptions .listeners

---

### name

ts

name: TName;


name: TName;

Defined in: packages/form-core/src/FieldApi.ts:415

The field name. The type will be DeepKeys<TParentData> to ensure your name is a deep key of the parent dataset.

#### Inherited from

FieldOptions .name

---

### validators?

ts

optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;


optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;

Defined in: packages/form-core/src/FieldApi.ts:431

A list of validators to pass to the field

#### Inherited from

FieldOptions .validators

Edit on GitHub

Functions / mergeForm

Interfaces / FieldOptions

Partners Become a Partner