Defined in: packages/form-core/src/FieldApi.ts:331
An object type representing the options for a field in a form.
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>
TOnDynamic extends undefined | FieldValidateOrFn<TParentData, TName, TData>
TOnDynamicAsync extends undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>
optional asyncAlways: boolean;
optional asyncAlways: boolean;
Defined in: packages/form-core/src/types.ts:972
If true, always run async validation, even if there are errors emitted during synchronous validation.
FieldLikeOptions.asyncAlways
FieldLikeOptions.asyncAlways
optional asyncDebounceMs: number;
optional asyncDebounceMs: number;
Defined in: packages/form-core/src/types.ts:968
The default time to debounce async validation if there is not a more specific debounce time passed.
FieldLikeOptions.asyncDebounceMs
FieldLikeOptions.asyncDebounceMs
optional defaultMeta: Partial<FieldLikeMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;
optional defaultMeta: Partial<FieldLikeMeta<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/types.ts:976
An optional object with default metadata for the field.
FieldLikeOptions.defaultMeta
FieldLikeOptions.defaultMeta
optional defaultValue: NoInfer<TData>;
optional defaultValue: NoInfer<TData>;
Defined in: packages/form-core/src/types.ts:964
An optional default value for the field.
FieldLikeOptions.defaultValue
FieldLikeOptions.defaultValue
optional disableErrorFlat: boolean;
optional disableErrorFlat: boolean;
Defined in: packages/form-core/src/types.ts:1004
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.
FieldLikeOptions.disableErrorFlat
FieldLikeOptions.disableErrorFlat
optional listeners: FieldListeners<TParentData, TName, TData>;
optional listeners: FieldListeners<TParentData, TName, TData>;
Defined in: packages/form-core/src/FieldApi.ts:325
A list of listeners which attach to the corresponding events
FieldExtraOptions.listeners
FieldExtraOptions.listeners
name: TName;
name: TName;
Defined in: packages/form-core/src/types.ts:960
The field name. The type will be DeepKeys<TParentData> to ensure your name is a deep key of the parent dataset.
FieldLikeOptions.name
FieldLikeOptions.name
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:307
A list of validators to pass to the field
FieldExtraOptions.validators
FieldExtraOptions.validators