Framework
Version
API-Referenz

BaseFormState

Typalias: BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>

ts
type BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer> = object;
type BaseFormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer> = object;

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

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

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>

Typdeklaration

_force_re_eval?

ts
optional _force_re_eval: boolean;
optional _force_re_eval: boolean;

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

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

Die Fehlerzuordnung für das Formular selbst.

fieldMetaBase

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

Eine Aufzeichnung von Feldmetadaten für jedes Feld im Formular, ohne abgeleitete Eigenschaften wie errors und ähnliches.

isSubmitSuccessful

ts
isSubmitSuccessful: boolean;
isSubmitSuccessful: boolean;

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

isSubmitted

ts
isSubmitted: boolean;
isSubmitted: boolean;

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

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

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

isSubmitting

ts
isSubmitting: boolean;
isSubmitting: boolean;

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

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

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

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

Dies ist nützlich, um Ladeanzeigen anzuzeigen oder Formularfelder während der Übermittlung zu deaktivieren.

isValidating

ts
isValidating: boolean;
isValidating: boolean;

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

submissionAttempts

ts
submissionAttempts: number;
submissionAttempts: number;

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

validationMetaMap

ts
validationMetaMap: Record<ValidationErrorMapKeys, ValidationMeta | undefined>;
validationMetaMap: Record<ValidationErrorMapKeys, ValidationMeta | undefined>;

Ein interner Mechanismus zur Verwaltung der Validierungslogik in einem Formular.

values

ts
values: TFormData;
values: TFormData;

Die aktuellen Werte der Formularfelder.

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.