FormGroupApiOptions | TanStack Form Français

Defined in: packages/form-core/src/FormGroupApi.ts:562

Extends

FormGroupOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TSubmitMeta, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>

Type Parameters

TParentData

TParentData

TName

TName extends DeepKeys<TParentData>

TData

TData extends DeepValue<TParentData, TName>

TOnMount

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

TOnChange

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

TOnChangeAsync

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

TOnBlur

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

TOnBlurAsync

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

TOnSubmit

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

TOnSubmitAsync

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

TOnDynamic

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

TOnDynamicAsync

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

TSubmitMeta

TSubmitMeta

TFormOnMount

TFormOnMount extends undefined | FormValidateOrFn<TParentData>

TFormOnChange

TFormOnChange extends undefined | FormValidateOrFn<TParentData>

TFormOnChangeAsync

TFormOnChangeAsync extends undefined | FormAsyncValidateOrFn<TParentData>

TFormOnBlur

TFormOnBlur extends undefined | FormValidateOrFn<TParentData>

TFormOnBlurAsync

TFormOnBlurAsync extends undefined | FormAsyncValidateOrFn<TParentData>

TFormOnSubmit

TFormOnSubmit extends undefined | FormValidateOrFn<TParentData>

TFormOnSubmitAsync

TFormOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TParentData>

TFormOnDynamic

TFormOnDynamic extends undefined | FormValidateOrFn<TParentData>

TFormOnDynamicAsync

TFormOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TParentData>

TFormOnServer

TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>

TParentSubmitMeta

TParentSubmitMeta

Properties

asyncAlways?

optional asyncAlways: boolean;

Defined in: packages/form-core/src/types.ts:982

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

Inherited from

FormGroupOptions.asyncAlways

asyncDebounceMs?

optional asyncDebounceMs: number;

Defined in: packages/form-core/src/types.ts:978

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

Inherited from

FormGroupOptions.asyncDebounceMs

canSubmitWhenInvalid?

optional canSubmitWhenInvalid: boolean;

Defined in: packages/form-core/src/FormGroupApi.ts:381

If true, allows the form to be submitted in an invalid state i.e. canSubmit will remain true regardless of validation errors. Defaults to undefined.

Inherited from

FormGroupOptions.canSubmitWhenInvalid

defaultMeta?

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

An optional object with default metadata for the field.

Inherited from

FormGroupOptions.defaultMeta

defaultState?

optional defaultState: FormGroupState;

Defined in: packages/form-core/src/FormGroupApi.ts:388

Inherited from

FormGroupOptions.defaultState

defaultValue?

optional defaultValue: NoInfer<TData>;

Defined in: packages/form-core/src/types.ts:974

An optional default value for the field.

Inherited from

FormGroupOptions.defaultValue

disableErrorFlat?

optional disableErrorFlat: boolean;

Defined in: packages/form-core/src/types.ts:1014

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.

Inherited from

FormGroupOptions.disableErrorFlat

form

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

Defined in: packages/form-core/src/FormGroupApi.ts:639

listeners?

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

Defined in: packages/form-core/src/FormGroupApi.ts:386

A list of listeners which attach to the corresponding events

Inherited from

FormGroupOptions.listeners

name

name: TName;

Defined in: packages/form-core/src/types.ts:970

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

Inherited from

FormGroupOptions.name

onGroupSubmit()?

optional onGroupSubmit: (props) => any;

Defined in: packages/form-core/src/FormGroupApi.ts:403

A function to be called when the form is submitted, what should happen once the user submits a valid form returns any or a promise Promise<any>

Parameters

props

groupApi

FormGroupApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TSubmitMeta, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>

value

TData

Returns

any

Inherited from

FormGroupOptions.onGroupSubmit

onGroupSubmitInvalid()?

optional onGroupSubmitInvalid: (props) => void;

Defined in: packages/form-core/src/FormGroupApi.ts:436

Specify an action for scenarios where the user tries to submit an invalid form.

Parameters

props

groupApi

value

TData

Returns

void

Inherited from

FormGroupOptions.onGroupSubmitInvalid

onSubmitMeta?

optional onSubmitMeta: TSubmitMeta;

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

onSubmitMeta, the data passed from the handleSubmit handler, to the onSubmit function props

Inherited from

FormGroupOptions.onSubmitMeta

validationLogic?

optional validationLogic: ValidationLogicFn;

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

Optional validation logic strategy to use for this group's own validators (e.g. revalidateLogic()). When omitted, the parent form's validationLogic (or the default) is used.

Inherited from

FormGroupOptions.validationLogic

validators?

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

Defined in: packages/form-core/src/FormGroupApi.ts:363

A list of validators to pass to the field

Inherited from

FormGroupOptions.validators