Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

fieldapioptions.md

202 lines6.7 KB

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?

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?

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?

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?

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?

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

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

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


listeners?

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

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?

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