TanStack
Form v1
Auto
Framework
Version
Menü
Erste Schritte
Anleitungen
API-Referenz
Community Resources
Beispiele

FormState

Interface: FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>

Definiert in: packages/form-core/src/FormApi.ts:719

Ein Objekt, das den aktuellen Zustand des Formulars repräsentiert.

Erbt von
  • BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>.DerivedFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>

Typparameter

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

Eigenschaften

_force_re_eval?

ts
optional _force_re_eval: boolean;

optional _force_re_eval: boolean;

Definiert in: packages/form-core/src/FormApi.ts:638

@private, wird verwendet, um eine Neubewertung des Formularzustands zu erzwingen, wenn sich Optionen ändern

Geerbt von
ts
BaseFormState._force_re_eval

BaseFormState._force_re_eval

canSubmit
ts
canSubmit: boolean;

canSubmit: boolean;

Definiert in: packages/form-core/src/FormApi.ts:712

Ein boolescher Wert, der angibt, ob das Formular basierend auf seinem aktuellen Zustand übermittelt werden kann.

Geerbt von
ts
DerivedFormState.canSubmit

DerivedFormState.canSubmit

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

Definiert in: packages/form-core/src/FormApi.ts:582

Die Fehlertabelle für das Formular selbst.

Geerbt von
ts
BaseFormState.errorMap

BaseFormState.errorMap

Fehler
ts
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>)[];

Definiert in: packages/form-core/src/FormApi.ts:665

Das Fehler-Array für das Formular selbst.

Geerbt von
ts
DerivedFormState.errors

DerivedFormState.errors

fieldMeta
ts
fieldMeta: Record<DeepKeys<TFormData>, AnyFieldMeta>;

fieldMeta: Record<DeepKeys<TFormData>, AnyFieldMeta>;

Definiert in: packages/form-core/src/FormApi.ts:716

Eine Aufzeichnung von Feldmetadaten für jedes Feld im Formular.

Geerbt von
ts
DerivedFormState.fieldMeta

DerivedFormState.fieldMeta

fieldMetaBase
ts
fieldMetaBase: Record<DeepKeys<TFormData>, AnyFieldMetaBase>;

fieldMetaBase: Record<DeepKeys<TFormData>, AnyFieldMetaBase>;

Definiert in: packages/form-core/src/FormApi.ts:601

Eine Aufzeichnung von Feldmetadaten für jedes Feld im Formular, einschließlich der abgeleiteten Eigenschaften wie Fehler und so weiter

Geerbt von
ts
BaseFormState.fieldMetaBase

BaseFormState.fieldMetaBase

istVerwaschen
ts
isBlurred: boolean;

isBlurred: boolean;

Definiert in: packages/form-core/src/FormApi.ts:692

Ein boolescher Wert, der angibt, ob eines der Formularfelder berührt wurde.

Geerbt von
ts
DerivedFormState.isBlurred

DerivedFormState.isBlurred

istStandardwert
ts
isDefaultValue: boolean;

isDefaultValue: boolean;

Definiert in: packages/form-core/src/FormApi.ts:704

Ein boolescher Wert, der angibt, ob alle Felder des Formulars mit den Standardwerten übereinstimmen.

Geerbt von
ts
DerivedFormState.isDefaultValue

DerivedFormState.isDefaultValue

istVerunreinigt
ts
isDirty: boolean;

isDirty: boolean;

Definiert in: packages/form-core/src/FormApi.ts:696

Ein boolescher Wert, der angibt, ob die Werte eines der Formularfelder vom Benutzer geändert wurden. Wertet true aus, wenn der Benutzer mindestens ein Feld geändert hat. Das Gegenteil von isPristine.

Geerbt von
ts
DerivedFormState.isDirty

DerivedFormState.isDirty

isFieldsValid
ts
isFieldsValid: boolean;

isFieldsValid: boolean;

Definiert in: packages/form-core/src/FormApi.ts:684

Ein boolescher Wert, der angibt, ob alle Formularfelder gültig sind. Wertet true aus, wenn keine Feldfehler vorhanden sind.

Geerbt von
ts
DerivedFormState.isFieldsValid

DerivedFormState.isFieldsValid

isFieldsValidating
ts
isFieldsValidating: boolean;

isFieldsValidating: boolean;

Definiert in: packages/form-core/src/FormApi.ts:680

Ein boolescher Wert, der angibt, ob eines der Formularfelder gerade validiert wird.

Geerbt von
ts
DerivedFormState.isFieldsValidating

DerivedFormState.isFieldsValidating

isFormValid
ts
isFormValid: boolean;

isFormValid: boolean;

Definiert in: packages/form-core/src/FormApi.ts:661

Ein boolescher Wert, der angibt, ob das Formular gültig ist.

Geerbt von
ts
DerivedFormState.isFormValid

DerivedFormState.isFormValid

isFormValidating
ts
isFormValidating: boolean;

isFormValidating: boolean;

Definiert in: packages/form-core/src/FormApi.ts:657

Ein boolescher Wert, der angibt, ob das Formular gerade validiert wird.

Geerbt von
ts
DerivedFormState.isFormValidating

DerivedFormState.isFormValidating

istUnberührt
ts
isPristine: boolean;

isPristine: boolean;

Definiert in: packages/form-core/src/FormApi.ts:700

Ein boolescher Wert, der angibt, ob keiner der Werte eines Formularfelds vom Benutzer geändert wurde. Wertet true aus, wenn der Benutzer keine Felder geändert hat. Das Gegenteil von isDirty.

Geerbt von
ts
DerivedFormState.isPristine

DerivedFormState.isPristine

isSubmitSuccessful
ts
isSubmitSuccessful: boolean;

isSubmitSuccessful: boolean;

Definiert in: packages/form-core/src/FormApi.ts:634

Ein boolescher Wert, der angibt, ob die letzte Übermittlung erfolgreich war.

Geerbt von
ts
BaseFormState.isSubmitSuccessful

BaseFormState.isSubmitSuccessful

isSubmitted
ts
isSubmitted: boolean;

isSubmitted: boolean;

Definiert in: packages/form-core/src/FormApi.ts:622

Ein boolescher Wert, der angibt, ob die onSubmit Funktion erfolgreich abgeschlossen wurde.

Wird bei jedem neuen Übermittlungsversuch auf false zurückgesetzt.

Hinweis: Sie können isSubmitting verwenden, um zu prüfen, ob das Formular gerade übermittelt wird.

Geerbt von
ts
BaseFormState.isSubmitted

BaseFormState.isSubmitted

isSubmitting
ts
isSubmitting: boolean;

isSubmitting: boolean;

Definiert in: packages/form-core/src/FormApi.ts:614

Ein boolescher Wert, der angibt, ob das Formular gerade übermittelt wird, nachdem handleSubmit aufgerufen wurde.

Wird auf false zurückgesetzt, wenn die Übermittlung aus einem der folgenden Gründe abgeschlossen ist

  • Der Validierungsschritt gab Fehler zurück.
  • Die onSubmit Funktion wurde abgeschlossen.

Hinweis: Wenn Sie asynchrone Operationen in Ihrer onSubmit Funktion ausführen, stellen Sie sicher, dass Sie auf sie warten, um sicherzustellen, dass isSubmitting erst auf false gesetzt wird, wenn die asynchrone Operation abgeschlossen ist.

Dies ist nützlich für die Anzeige von Ladeindikatoren oder das Deaktivieren von Formulareingaben während der Übermittlung.

Geerbt von
ts
BaseFormState.isSubmitting

BaseFormState.isSubmitting

wurdeBerührt
ts
isTouched: boolean;

isTouched: boolean;

Definiert in: packages/form-core/src/FormApi.ts:688

Ein boolescher Wert, der angibt, ob eines der Formularfelder berührt wurde.

Geerbt von
ts
DerivedFormState.isTouched

DerivedFormState.isTouched

istGültig
ts
isValid: boolean;

isValid: boolean;

Definiert in: packages/form-core/src/FormApi.ts:708

Ein boolescher Wert, der angibt, ob das Formular und alle seine Felder gültig sind. Wertet true aus, wenn keine Fehler vorhanden sind.

Geerbt von
ts
DerivedFormState.isValid

DerivedFormState.isValid

isValidating
ts
isValidating: boolean;

isValidating: boolean;

Definiert in: packages/form-core/src/FormApi.ts:626

Ein boolescher Wert, der angibt, ob das Formular oder eines seiner Felder gerade validiert wird.

Geerbt von
ts
BaseFormState.isValidating

BaseFormState.isValidating

submissionAttempts
ts
submissionAttempts: number;

submissionAttempts: number;

Definiert in: packages/form-core/src/FormApi.ts:630

Ein Zähler zur Verfolgung der Anzahl der Übermittlungsversuche.

Geerbt von
ts
BaseFormState.submissionAttempts

BaseFormState.submissionAttempts

validationMetaMap
ts
validationMetaMap: Record<"onMount" | "onChange" | "onBlur" | "onSubmit" | "onDynamic" | "onServer", undefined | ValidationMeta>;

validationMetaMap: Record<"onMount" | "onChange" | "onBlur" | "onSubmit" | "onDynamic" | "onServer", undefined | ValidationMeta>;

Definiert in: packages/form-core/src/FormApi.ts:597

Ein interner Mechanismus zur Verfolgung der Validierungslogik in einem Formular.

Geerbt von
ts
BaseFormState.validationMetaMap

BaseFormState.validationMetaMap

values
ts
values: TFormData;

values: TFormData;

Definiert in: packages/form-core/src/FormApi.ts:578

Die aktuellen Werte der Formularfelder.

Geerbt von
ts
BaseFormState.values

BaseFormState.values
Auf GitHub bearbeiten
Startseite
Unsere Partner
Code Rabbit
Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.

Bytes abonnieren

Ihre wöchentliche Dosis JavaScript-Nachrichten. Jeden Montag kostenlos an über 100.000 Entwickler geliefert.

Bytes

Kein Spam. Jederzeit kündbar.