An object type representing the options for a field in a form.

• FieldApiOptions

• TParentData

• TName extends DeepKeys<TParentData>

• TFieldValidator extends Validator<DeepValue<TParentData, TName>, unknown> | undefined = undefined

• TFormValidator extends Validator<TParentData, unknown> | undefined = undefined

• TData extends DeepValue<TParentData, TName> = DeepValue<TParentData, TName>

optional asyncAlways: boolean;

optional asyncAlways: boolean;

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

packages/form-core/src/FieldApi.ts:346

optional asyncDebounceMs: number;

optional asyncDebounceMs: number;

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

packages/form-core/src/FieldApi.ts:342

optional defaultMeta: Partial<FieldMeta>;

optional defaultMeta: Partial<FieldMeta>;

An optional object with default metadata for the field.

packages/form-core/src/FieldApi.ts:364

optional defaultValue: NoInfer<TData>;

optional defaultValue: NoInfer<TData>;

An optional default value for the field.

packages/form-core/src/FieldApi.ts:338

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

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

A list of listeners which attach to the corresponding events

packages/form-core/src/FieldApi.ts:368

name: TName;

name: TName;

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

packages/form-core/src/FieldApi.ts:334

optional validatorAdapter: TFieldValidator;

optional validatorAdapter: TFieldValidator;

A validator provided by an extension, like yupValidator from @tanstack/yup-form-adapter

packages/form-core/src/FieldApi.ts:350

optional validators: FieldValidators<TParentData, TName, TFieldValidator, TFormValidator, TData>;

optional validators: FieldValidators<TParentData, TName, TFieldValidator, TFormValidator, TData>;

A list of validators to pass to the field

packages/form-core/src/FieldApi.ts:354