Interface: FieldApiOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>

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

• FieldOptions<TParentData, TName, TFieldValidator, TFormValidator, TData>

• 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.

FieldOptions.asyncAlways

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

optional asyncDebounceMs: number;

optional asyncDebounceMs: number;

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

FieldOptions.asyncDebounceMs

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

optional defaultMeta: Partial<FieldMeta>;

optional defaultMeta: Partial<FieldMeta>;

An optional object with default metadata for the field.

FieldOptions.defaultMeta

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

optional defaultValue: NoInfer<TData>;

optional defaultValue: NoInfer<TData>;

An optional default value for the field.

FieldOptions.defaultValue

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

form: FormApi<TParentData, TFormValidator>;

form: FormApi<TParentData, TFormValidator>;

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

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.

FieldOptions.name

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

optional preserveValue: boolean;

optional preserveValue: boolean;

FieldOptions.preserveValue

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

optional validatorAdapter: TFieldValidator;

optional validatorAdapter: TFieldValidator;

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

FieldOptions.validatorAdapter

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

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

FieldOptions.validators

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