Defined in: packages/form-core/src/FieldGroupApi.ts:112
• TFormData
• TFieldGroupData
• TFields extends | DeepKeysOfType<TFormData, TFieldGroupData | null | undefined> | FieldsMap<TFormData, TFieldGroupData>
• TOnMount extends undefined | FormValidateOrFn<TFormData>
• TOnChange extends undefined | FormValidateOrFn<TFormData>
• TOnChangeAsync extends undefined | FormAsyncValidateOrFn<TFormData>
• TOnBlur extends undefined | FormValidateOrFn<TFormData>
• TOnBlurAsync extends undefined | FormAsyncValidateOrFn<TFormData>
• TOnSubmit extends undefined | FormValidateOrFn<TFormData>
• TOnSubmitAsync extends undefined | FormAsyncValidateOrFn<TFormData>
• TOnDynamic extends undefined | FormValidateOrFn<TFormData>
• TOnDynamicAsync extends undefined | FormAsyncValidateOrFn<TFormData>
• TOnServer extends undefined | FormAsyncValidateOrFn<TFormData>
• TSubmitMeta = never
new FieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(opts): FieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
new FieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(opts): FieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
Defined in: packages/form-core/src/FieldGroupApi.ts:187
Constructs a new FieldGroupApi instance with the given form options.
FieldGroupOptions<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
FieldGroupApi<TFormData, TFieldGroupData, TFields, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
readonly fieldsMap: TFields;
readonly fieldsMap: TFields;
Defined in: packages/form-core/src/FieldGroupApi.ts:149
readonly form: FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
readonly form: FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
Defined in: packages/form-core/src/FieldGroupApi.ts:134
The form that called this field group.
store: Derived<FieldGroupState<TFieldGroupData>>;
store: Derived<FieldGroupState<TFieldGroupData>>;
Defined in: packages/form-core/src/FieldGroupApi.ts:178
get state(): FieldGroupState<TFieldGroupData>
get state(): FieldGroupState<TFieldGroupData>
Defined in: packages/form-core/src/FieldGroupApi.ts:180
FieldGroupState<TFieldGroupData>
clearFieldValues<TField>(field, opts?): void
clearFieldValues<TField>(field, opts?): void
Defined in: packages/form-core/src/FieldGroupApi.ts:459
• TField extends string
TField
UpdateMetaOptions
void
FieldManipulator.clearFieldValues
FieldManipulator.clearFieldValues
deleteField<TField>(field): void
deleteField<TField>(field): void
Defined in: packages/form-core/src/FieldGroupApi.ts:346
Delete a field and its subfields.
• TField extends string
TField
void
FieldManipulator.deleteField
FieldManipulator.deleteField
getFieldMeta<TField>(field): undefined | AnyFieldMeta
getFieldMeta<TField>(field): undefined | AnyFieldMeta
Defined in: packages/form-core/src/FieldGroupApi.ts:314
Gets the metadata of the specified field.
• TField extends string
TField
undefined | AnyFieldMeta
FieldManipulator.getFieldMeta
FieldManipulator.getFieldMeta
getFieldValue<TField>(field): DeepValue<TFieldGroupData, TField>
getFieldValue<TField>(field): DeepValue<TFieldGroupData, TField>
Defined in: packages/form-core/src/FieldGroupApi.ts:302
Gets the value of the specified field.
• TField extends string
TField
DeepValue<TFieldGroupData, TField>
FieldManipulator.getFieldValue
FieldManipulator.getFieldValue
handleSubmit(): Promise<void>
handleSubmit(): Promise<void>
Defined in: packages/form-core/src/FieldGroupApi.ts:292
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
Promise<void>
FieldManipulator.handleSubmit
FieldManipulator.handleSubmit
handleSubmit(submitMeta): Promise<void>
handleSubmit(submitMeta): Promise<void>
Defined in: packages/form-core/src/FieldGroupApi.ts:293
Handles the form submission, performs validation, and calls the appropriate onSubmit or onSubmitInvalid callbacks.
TSubmitMeta
Promise<void>
FieldManipulator.handleSubmit
FieldManipulator.handleSubmit
insertFieldValue<TField>(
field,
index,
value,
opts?): Promise<void>
insertFieldValue<TField>(
field,
index,
value,
opts?): Promise<void>
Defined in: packages/form-core/src/FieldGroupApi.ts:371
Insert a value into an array field at the specified index.
• TField extends string
TField
number
DeepValue<TFieldGroupData, TField> extends any[] ? any[] & DeepValue<TFieldGroupData, TField>[number] : never
UpdateMetaOptions
Promise<void>
FieldManipulator.insertFieldValue
FieldManipulator.insertFieldValue
mount(): () => void
mount(): () => void
Defined in: packages/form-core/src/FieldGroupApi.ts:256
Mounts the field group instance to listen to value changes.
Function
void
moveFieldValues<TField>(
field,
index1,
index2,
opts?): void
moveFieldValues<TField>(
field,
index1,
index2,
opts?): void
Defined in: packages/form-core/src/FieldGroupApi.ts:445
Moves the value at the first specified index to the second specified index within an array field.
• TField extends string
TField
number
number
UpdateMetaOptions
void
FieldManipulator.moveFieldValues
FieldManipulator.moveFieldValues
pushFieldValue<TField>(
field,
value,
opts?): void
pushFieldValue<TField>(
field,
value,
opts?): void
Defined in: packages/form-core/src/FieldGroupApi.ts:353
Pushes a value into an array field.
• TField extends string
TField
DeepValue<TFieldGroupData, TField> extends any[] ? any[] & DeepValue<TFieldGroupData, TField>[number] : never
UpdateMetaOptions
void
FieldManipulator.pushFieldValue
FieldManipulator.pushFieldValue
removeFieldValue<TField>(
field,
index,
opts?): Promise<void>
removeFieldValue<TField>(
field,
index,
opts?): Promise<void>
Defined in: packages/form-core/src/FieldGroupApi.ts:415
Removes a value from an array field at the specified index.
• TField extends string
TField
number
UpdateMetaOptions
Promise<void>
FieldManipulator.removeFieldValue
FieldManipulator.removeFieldValue
replaceFieldValue<TField>(
field,
index,
value,
opts?): Promise<void>
replaceFieldValue<TField>(
field,
index,
value,
opts?): Promise<void>
Defined in: packages/form-core/src/FieldGroupApi.ts:393
Replaces a value into an array field at the specified index.
• TField extends string
TField
number
DeepValue<TFieldGroupData, TField> extends any[] ? any[] & DeepValue<TFieldGroupData, TField>[number] : never
UpdateMetaOptions
Promise<void>
FieldManipulator.replaceFieldValue
FieldManipulator.replaceFieldValue
resetField<TField>(field): void
resetField<TField>(field): void
Defined in: packages/form-core/src/FieldGroupApi.ts:469
Resets the field value and meta to default state
• TField extends string
TField
void
FieldManipulator.resetField
FieldManipulator.resetField
setFieldMeta<TField>(field, updater): void
setFieldMeta<TField>(field, updater): void
Defined in: packages/form-core/src/FieldGroupApi.ts:321
Updates the metadata of the specified field.
• TField extends string
TField
void
FieldManipulator.setFieldMeta
FieldManipulator.setFieldMeta
setFieldValue<TField>(
field,
updater,
opts?): void
setFieldValue<TField>(
field,
updater,
opts?): void
Defined in: packages/form-core/src/FieldGroupApi.ts:331
Sets the value of the specified field and optionally updates the touched state.
• TField extends string
TField
Updater<DeepValue<TFieldGroupData, TField>>
UpdateMetaOptions
void
FieldManipulator.setFieldValue
FieldManipulator.setFieldValue
swapFieldValues<TField>(
field,
index1,
index2,
opts?): void
swapFieldValues<TField>(
field,
index1,
index2,
opts?): void
Defined in: packages/form-core/src/FieldGroupApi.ts:428
Swaps the values at the specified indices within an array field.
• TField extends string
TField
number
number
UpdateMetaOptions
void
FieldManipulator.swapFieldValues
FieldManipulator.swapFieldValues
validateAllFields(cause): Promise<unknown[]>
validateAllFields(cause): Promise<unknown[]>
Defined in: packages/form-core/src/FieldGroupApi.ts:473
ValidationCause
Promise<unknown[]>
FieldManipulator.validateAllFields
FieldManipulator.validateAllFields
validateArrayFieldsStartingFrom<TField>(
field,
index,
cause): Promise<unknown[]>
validateArrayFieldsStartingFrom<TField>(
field,
index,
cause): Promise<unknown[]>
Defined in: packages/form-core/src/FieldGroupApi.ts:265
Validates the children of a specified array in the form starting from a given index until the end using the correct handlers for a given validation type.
• TField extends string
TField
number
ValidationCause
Promise<unknown[]>
FieldManipulator.validateArrayFieldsStartingFrom
FieldManipulator.validateArrayFieldsStartingFrom
validateField<TField>(field, cause): unknown[] | Promise<unknown[]>
validateField<TField>(field, cause): unknown[] | Promise<unknown[]>
Defined in: packages/form-core/src/FieldGroupApi.ts:282
Validates a specified field in the form using the correct handlers for a given validation type.
• TField extends string
TField
ValidationCause
unknown[] | Promise<unknown[]>
FieldManipulator.validateField
FieldManipulator.validateField
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.