Definiert in: packages/form-core/src/FormApi.ts:860
Eine Klasse, die die Formular-API darstellt. Sie kümmert sich um die Logik und die Interaktionen mit dem Formularzustand.
Normalerweise müssen Sie keine neue FormApi Instanz direkt erstellen. Stattdessen verwenden Sie einen Framework-Hook/-Funktion wie useForm oder createForm, um eine neue Instanz für Sie zu erstellen, die das reaktive Modell Ihres Frameworks verwendet. Wenn Sie jedoch eine neue Instanz manuell erstellen müssen, können Sie dies tun, indem Sie den new FormApi Konstruktor aufrufen.
• TFormData
• TOnMount erweitert undefined | FormValidateOrFn<TFormData>
• TOnChange erweitert undefined | FormValidateOrFn<TFormData>
• TOnChangeAsync erweitert undefined | FormAsyncValidateOrFn<TFormData>
• TOnBlur erweitert undefined | FormValidateOrFn<TFormData>
• TOnBlurAsync erweitert undefined | FormAsyncValidateOrFn<TFormData>
• TOnSubmit erweitert undefined | FormValidateOrFn<TFormData>
• TOnSubmitAsync erweitert undefined | FormAsyncValidateOrFn<TFormData>
• TOnDynamic erweitert undefined | FormValidateOrFn<TFormData>
• TOnDynamicAsync erweitert undefined | FormAsyncValidateOrFn<TFormData>
• TOnServer erweitert undefined | FormAsyncValidateOrFn<TFormData>
• TSubmitMeta = never
new FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(opts?): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
new FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>(opts?): FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
Definiert in: packages/form-core/src/FormApi.ts:940
Konstruiert eine neue FormApi Instanz mit den gegebenen Formularoptionen.
FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
baseStore: Store<BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
baseStore: Store<BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
Definiert in: packages/form-core/src/FormApi.ts:892
fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData>>;
fieldInfo: Record<DeepKeys<TFormData>, FieldInfo<TFormData>>;
Definiert in: packages/form-core/src/FormApi.ts:926
Ein Datensatz mit Feldinformationen für jedes Feld im Formular.
fieldMetaDerived: Derived<Record<DeepKeys<TFormData>, AnyFieldMeta>>;
fieldMetaDerived: Derived<Record<DeepKeys<TFormData>, AnyFieldMeta>>;
Definiert in: packages/form-core/src/FormApi.ts:907
options: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta> = {};
options: FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta> = {};
Definiert in: packages/form-core/src/FormApi.ts:878
Die Optionen für das Formular.
store: Derived<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
store: Derived<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
Definiert in: packages/form-core/src/FormApi.ts:908
get formId(): undefined | string
get formId(): undefined | string
Definiert in: packages/form-core/src/FormApi.ts:1249
undefined | string
get state(): FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>
get state(): FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>
Definiert in: packages/form-core/src/FormApi.ts:928
FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>
clearFieldValues<TField>(field, opts?): void
clearFieldValues<TField>(field, opts?): void
Definiert in: packages/form-core/src/FormApi.ts:2291
Löscht alle Werte innerhalb eines Array-Feldes.
• TField extends string
TField
UpdateMetaOptions
void
FieldManipulator.clearFieldValues
FieldManipulator.clearFieldValues
deleteField<TField>(field): void
deleteField<TField>(field): void
Definiert in: packages/form-core/src/FormApi.ts:2099
• TField extends string
TField
void
FieldManipulator.deleteField
FieldManipulator.deleteField
getAllErrors(): object
getAllErrors(): object
Definiert in: packages/form-core/src/FormApi.ts:2399
Gibt Formular- und Feldfehler zurück
Objekt
fields: Record<DeepKeys<TFormData>, {
errorMap: ValidationErrorMap;
errors: unknown[];
}>;
fields: Record<DeepKeys<TFormData>, {
errorMap: ValidationErrorMap;
errors: unknown[];
}>;
form: object;
form: object;
errorMap: ValidationErrorMap<UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormValidateOrFn<TOnDynamic>, UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>;
errorMap: ValidationErrorMap<UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormValidateOrFn<TOnDynamic>, UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>;
errors: (
| UnwrapFormValidateOrFn<TOnMount>
| UnwrapFormValidateOrFn<TOnChange>
| UnwrapFormAsyncValidateOrFn<TOnChangeAsync>
| UnwrapFormValidateOrFn<TOnBlur>
| UnwrapFormAsyncValidateOrFn<TOnBlurAsync>
| UnwrapFormValidateOrFn<TOnSubmit>
| UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>
| UnwrapFormValidateOrFn<TOnDynamic>
| UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>
| UnwrapFormAsyncValidateOrFn<TOnServer>)[];
errors: (
| UnwrapFormValidateOrFn<TOnMount>
| UnwrapFormValidateOrFn<TOnChange>
| UnwrapFormAsyncValidateOrFn<TOnChangeAsync>
| UnwrapFormValidateOrFn<TOnBlur>
| UnwrapFormAsyncValidateOrFn<TOnBlurAsync>
| UnwrapFormValidateOrFn<TOnSubmit>
| UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>
| UnwrapFormValidateOrFn<TOnDynamic>
| UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>
| UnwrapFormAsyncValidateOrFn<TOnServer>)[];
getFieldInfo<TField>(field): FieldInfo<TFormData>
getFieldInfo<TField>(field): FieldInfo<TFormData>
Definiert in: packages/form-core/src/FormApi.ts:2012
Ruft die Feldinformationen des angegebenen Feldes ab.
• TField extends string
TField
FieldInfo<TFormData>
getFieldMeta<TField>(field): undefined | AnyFieldMeta
getFieldMeta<TField>(field): undefined | AnyFieldMeta
Definiert in: packages/form-core/src/FormApi.ts:2003
Ruft die Metadaten des angegebenen Feldes ab.
• TField extends string
TField
undefined | AnyFieldMeta
FieldManipulator.getFieldMeta
FieldManipulator.getFieldMeta
getFieldValue<TField>(field): DeepValue<TFormData, TField>
getFieldValue<TField>(field): DeepValue<TFormData, TField>
Definiert in: packages/form-core/src/FormApi.ts:1996
Ruft den Wert des angegebenen Feldes ab.
• TField extends string
TField
DeepValue<TFormData, TField>
FieldManipulator.getFieldValue
FieldManipulator.getFieldValue
handleSubmit(): Promise<void>
handleSubmit(): Promise<void>
Definiert in: packages/form-core/src/FormApi.ts:1893
Verarbeitet die Formularübermittlung, führt die Validierung durch und ruft die entsprechenden Rückrufe onSubmit oder onSubmitInvalid auf.
Promise<void>
FieldManipulator.handleSubmit
FieldManipulator.handleSubmit
handleSubmit(submitMeta): Promise<void>
handleSubmit(submitMeta): Promise<void>
Definiert in: packages/form-core/src/FormApi.ts:1894
Verarbeitet die Formularübermittlung, führt die Validierung durch und ruft die entsprechenden Rückrufe onSubmit oder onSubmitInvalid auf.
TSubmitMeta
Promise<void>
FieldManipulator.handleSubmit
FieldManipulator.handleSubmit
insertFieldValue<TField>(
field,
index,
value,
opts?): Promise<void>
insertFieldValue<TField>(
field,
index,
value,
opts?): Promise<void>
Definiert in: packages/form-core/src/FormApi.ts:2138
• TField extends string
TField
number
DeepValue<TFormData, TField> extends any[] ? any[] & DeepValue<TFormData, TField>[number] : never
UpdateMetaOptions
Promise<void>
FieldManipulator.insertFieldValue
FieldManipulator.insertFieldValue
mount(): () => void
mount(): () => void
Definiert in: packages/form-core/src/FormApi.ts:1278
Funktion
void
moveFieldValues<TField>(
field,
index1,
index2,
opts?): void
moveFieldValues<TField>(
field,
index1,
index2,
opts?): void
Definiert in: packages/form-core/src/FormApi.ts:2262
Verschiebt den Wert am ersten angegebenen Index an den zweiten angegebenen Index innerhalb eines Array-Feldes.
• TField extends string
TField
number
number
UpdateMetaOptions
void
FieldManipulator.moveFieldValues
FieldManipulator.moveFieldValues
parseValuesWithSchema(schema):
| undefined
| {
fields: Record<string, StandardSchemaV1Issue[]>;
form: Record<string, StandardSchemaV1Issue[]>;
}
parseValuesWithSchema(schema):
| undefined
| {
fields: Record<string, StandardSchemaV1Issue[]>;
form: Record<string, StandardSchemaV1Issue[]>;
}
Definiert in: packages/form-core/src/FormApi.ts:2463
Analysiert die Formularwerte mit einem gegebenen Standard-Schema und gibt Probleme (falls vorhanden) zurück. Diese Methode setzt KEINE internen Fehler.
StandardSchemaV1<TFormData, unknown>
Das Standard-Schema, mit dem die Formularwerte analysiert werden sollen.
| undefined | { fields: Record<string, StandardSchemaV1Issue[]>; form: Record<string, StandardSchemaV1Issue[]>; }
parseValuesWithSchemaAsync(schema): Promise<
| undefined
| {
fields: Record<string, StandardSchemaV1Issue[]>;
form: Record<string, StandardSchemaV1Issue[]>;
}>
parseValuesWithSchemaAsync(schema): Promise<
| undefined
| {
fields: Record<string, StandardSchemaV1Issue[]>;
form: Record<string, StandardSchemaV1Issue[]>;
}>
Definiert in: packages/form-core/src/FormApi.ts:2475
Analysiert die Formularwerte mit einem gegebenen Standard-Schema und gibt Probleme (falls vorhanden) zurück. Diese Methode setzt KEINE internen Fehler.
StandardSchemaV1<TFormData, unknown>
Das Standard-Schema, mit dem die Formularwerte analysiert werden sollen.
Promise< | undefined | { fields: Record<string, StandardSchemaV1Issue[]>; form: Record<string, StandardSchemaV1Issue[]>; }>
pushFieldValue<TField>(
field,
value,
opts?): void
pushFieldValue<TField>(
field,
value,
opts?): void
Definiert in: packages/form-core/src/FormApi.ts:2123
Fügt einen Wert zu einem Array-Feld hinzu.
• TField extends string
TField
DeepValue<TFormData, TField> extends any[] ? any[] & DeepValue<TFormData, TField>[number] : never
UpdateMetaOptions
void
FieldManipulator.pushFieldValue
FieldManipulator.pushFieldValue
removeFieldValue<TField>(
field,
index,
opts?): Promise<void>
removeFieldValue<TField>(
field,
index,
opts?): Promise<void>
Definiert in: packages/form-core/src/FormApi.ts:2196
Entfernt einen Wert aus einem Array-Feld am angegebenen 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>
Definiert in: packages/form-core/src/FormApi.ts:2170
Ersetzt einen Wert in einem Array-Feld am angegebenen Index.
• TField extends string
TField
number
DeepValue<TFormData, TField> extends any[] ? any[] & DeepValue<TFormData, TField>[number] : never
UpdateMetaOptions
Promise<void>
FieldManipulator.replaceFieldValue
FieldManipulator.replaceFieldValue
reset(values?, opts?): void
reset(values?, opts?): void
Definiert in: packages/form-core/src/FormApi.ts:1368
Setzt den Formularzustand auf die Standardwerte zurück. Wenn Werte angegeben werden, wird das Formular stattdessen auf diese Werte zurückgesetzt und die Standardwerte werden aktualisiert.
TFormData
Optionale Werte, auf die das Formular zurückgesetzt werden soll.
Optionale Optionen zur Steuerung des Rücksetzverhaltens.
boolean
void
resetField<TField>(field): void
resetField<TField>(field): void
Definiert in: packages/form-core/src/FormApi.ts:2317
Setzt den Feldwert und die Metadaten auf den Standardzustand zurück
• TField extends string
TField
void
FieldManipulator.resetField
FieldManipulator.resetField
resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>
resetFieldMeta<TField>(fieldMeta): Record<TField, AnyFieldMeta>
Definiert in: packages/form-core/src/FormApi.ts:2053
Setzt die Metadaten jedes Feldes zurück
• TField extends string
Record<TField, AnyFieldMeta>
Record<TField, AnyFieldMeta>
setErrorMap(errorMap): void
setErrorMap(errorMap): void
Definiert in: packages/form-core/src/FormApi.ts:2335
Aktualisiert den errorMap des Formulars
FormValidationErrorMap<TFormData, UnwrapFormValidateOrFn<TOnMount>, UnwrapFormValidateOrFn<TOnChange>, UnwrapFormAsyncValidateOrFn<TOnChangeAsync>, UnwrapFormValidateOrFn<TOnBlur>, UnwrapFormAsyncValidateOrFn<TOnBlurAsync>, UnwrapFormValidateOrFn<TOnSubmit>, UnwrapFormAsyncValidateOrFn<TOnSubmitAsync>, UnwrapFormValidateOrFn<TOnDynamic>, UnwrapFormAsyncValidateOrFn<TOnDynamicAsync>, UnwrapFormAsyncValidateOrFn<TOnServer>>
void
setFieldMeta<TField>(field, updater): void
setFieldMeta<TField>(field, updater): void
Definiert in: packages/form-core/src/FormApi.ts:2032
Aktualisiert die Metadaten des angegebenen Feldes.
• TField extends string
TField
void
FieldManipulator.setFieldMeta
FieldManipulator.setFieldMeta
setFieldValue<TField>(
field,
updater,
opts?): void
setFieldValue<TField>(
field,
updater,
opts?): void
Definiert in: packages/form-core/src/FormApi.ts:2069
Setzt den Wert des angegebenen Feldes und optional den Zustand "berührt".
• TField extends string
TField
Updater<DeepValue<TFormData, TField>>
UpdateMetaOptions
void
FieldManipulator.setFieldValue
FieldManipulator.setFieldValue
swapFieldValues<TField>(
field,
index1,
index2,
opts?): void
swapFieldValues<TField>(
field,
index1,
index2,
opts?): void
Definiert in: packages/form-core/src/FormApi.ts:2233
Tauscht die Werte an den angegebenen Indizes innerhalb eines Array-Feldes.
• TField extends string
TField
number
number
UpdateMetaOptions
void
FieldManipulator.swapFieldValues
FieldManipulator.swapFieldValues
update(options?): void
update(options?): void
Definiert in: packages/form-core/src/FormApi.ts:1298
Aktualisiert die Formularoptionen und den Formularzustand.
FormOptions<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>
void
validateAllFields(cause): Promise<unknown[]>
validateAllFields(cause): Promise<unknown[]>
Definiert in: packages/form-core/src/FormApi.ts:1394
Validiert alle Felder mit den richtigen Handlern für eine gegebene Validierungsursache.
ValidationCause
Promise<unknown[]>
FieldManipulator.validateAllFields
FieldManipulator.validateAllFields
validateArrayFieldsStartingFrom<TField>(
field,
index,
cause): Promise<unknown[]>
validateArrayFieldsStartingFrom<TField>(
field,
index,
cause): Promise<unknown[]>
Definiert in: packages/form-core/src/FormApi.ts:1424
Validiert die Elemente eines angegebenen Arrays im Formular ab einem gegebenen Index bis zum Ende, unter Verwendung der richtigen Handler für einen gegebenen Validierungstyp.
• 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[]>
Definiert in: packages/form-core/src/FormApi.ts:1465
Validiert ein angegebenes Feld im Formular mit den richtigen Handlern für einen gegebenen Validierungstyp.
• TField extends string
TField
ValidationCause
unknown[] | Promise<unknown[]>
FieldManipulator.validateField
FieldManipulator.validateField
Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.