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

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

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

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

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

• TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>

• TParentSubmitMeta

optional asyncAlways: boolean;

optional asyncAlways: boolean;

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

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

FieldOptions.asyncAlways

optional asyncDebounceMs: number;

optional asyncDebounceMs: number;

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

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

FieldOptions.asyncDebounceMs

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

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

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

An optional object with default metadata for the field.

FieldOptions.defaultMeta

optional defaultValue: NoInfer<TData>;

optional defaultValue: NoInfer<TData>;

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

An optional default value for the field.

FieldOptions.defaultValue

optional disableErrorFlat: boolean;

optional disableErrorFlat: boolean;

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

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.

FieldOptions.disableErrorFlat

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

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

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

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

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

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

A list of listeners which attach to the corresponding events

FieldOptions.listeners

name: TName;

name: TName;

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

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

FieldOptions.name

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

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

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

A list of validators to pass to the field

FieldOptions.validators