Interface: FieldOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>

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

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

Extended by

• FieldApiOptions

Type Parameters

TParentData

TParentData

TName

TName extends DeepKeys<TParentData>

TData

TData extends DeepValue<TParentData, TName>

TOnMount

TOnMount extends undefined | FieldValidateOrFn<TParentData, TName, TData>

TOnChange

TOnChange extends undefined | FieldValidateOrFn<TParentData, TName, TData>

TOnChangeAsync

TOnChangeAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

TOnBlur

TOnBlur extends undefined | FieldValidateOrFn<TParentData, TName, TData>

TOnBlurAsync

TOnBlurAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

TOnSubmit

TOnSubmit extends undefined | FieldValidateOrFn<TParentData, TName, TData>

TOnSubmitAsync

TOnSubmitAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

TOnDynamic

TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>

TOnDynamicAsync

TOnDynamicAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

Properties

asyncAlways?

optional asyncAlways: boolean;

optional asyncAlways: boolean;

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

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

asyncDebounceMs?

optional asyncDebounceMs: number;

optional asyncDebounceMs: number;

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

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

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

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

An optional object with default metadata for the field.

defaultValue?

optional defaultValue: NoInfer<TData>;

optional defaultValue: NoInfer<TData>;

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

An optional default value for the field.

disableErrorFlat?

optional disableErrorFlat: boolean;

optional disableErrorFlat: boolean;

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

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.

listeners?

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

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

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

A list of listeners which attach to the corresponding events

name

name: TName;

name: TName;

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

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

validators?

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

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

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

A list of validators to pass to the field