FieldApiOptions

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

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

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

Extends

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

Type Parameters

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>

Properties

asyncAlways?

ts
optional asyncAlways: boolean;
optional asyncAlways: boolean;

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

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

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>;
optional defaultMeta: Partial<FieldMeta>;

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

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

An optional default value for the field.

Inherited from

FieldOptions.defaultValue


form

ts
form: FormApi<TParentData, TFormValidator>;
form: FormApi<TParentData, TFormValidator>;

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


listeners?

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

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

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

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


validatorAdapter?

ts
optional validatorAdapter: TFieldValidator;
optional validatorAdapter: TFieldValidator;

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

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

Inherited from

FieldOptions.validatorAdapter


validators?

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

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

A list of validators to pass to the field

Inherited from

FieldOptions.validators

Subscribe to Bytes

Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.

Bytes

No spam. Unsubscribe at any time.