Framework
Version
API-Referenz

FormOptions

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

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

Ein Objekt, das die Optionen für ein Formular darstellt.

Erbt von

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>

TSubmitMeta = never

Eigenschaften

asyncAlways?

ts
optional asyncAlways: boolean;
optional asyncAlways: boolean;

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

Wenn true, wird die asynchrone Validierung immer ausgeführt, auch wenn die synchrone Validierung einen Fehler erzeugt hat. Standardmäßig undefined.


asyncDebounceMs?

ts
optional asyncDebounceMs: number;
optional asyncDebounceMs: number;

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

Optionale Zeit in Millisekunden, wenn Sie eine Verzögerung vor dem Auslösen einer asynchronen Aktion einführen möchten.


canSubmitWhenInvalid?

ts
optional canSubmitWhenInvalid: boolean;
optional canSubmitWhenInvalid: boolean;

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

Wenn true, erlaubt das Absenden des Formulars in einem ungültigen Zustand, d.h. canSubmit bleibt unabhängig von Validierungsfehlern true. Standardmäßig undefined.


defaultState?

ts
optional defaultState: Partial<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;
optional defaultState: Partial<FormState<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer>>;

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

Der Standardzustand für das Formular.


defaultValues?

ts
optional defaultValues: TFormData;
optional defaultValues: TFormData;

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

Legen Sie Anfangswerte für Ihr Formular fest.

Geerbt von

BaseFormOptions.defaultValues


formId?

ts
optional formId: string;
optional formId: string;

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

Der Name des Formulars, verwendet für Devtools und Identifikation


listeners?

ts
optional listeners: FormListeners<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;
optional listeners: FormListeners<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>;

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

Formular-weite Listener


onSubmit()?

ts
optional onSubmit: (props) => any;
optional onSubmit: (props) => any;

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

Eine Funktion, die aufgerufen wird, wenn das Formular abgesendet wird. Was passieren soll, nachdem der Benutzer ein gültiges Formular abgesendet hat. Gibt any oder ein Promise Promise<any> zurück.

Parameter

props
formApi

FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

meta

TSubmitMeta

value

TFormData

Gibt zurück

any


onSubmitInvalid()?

ts
optional onSubmitInvalid: (props) => void;
optional onSubmitInvalid: (props) => void;

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

Geben Sie eine Aktion für Szenarien an, in denen der Benutzer versucht, ein ungültiges Formular abzusenden.

Parameter

props
formApi

FormApi<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TOnServer, TSubmitMeta>

meta

TSubmitMeta

value

TFormData

Gibt zurück

void


onSubmitMeta?

ts
optional onSubmitMeta: TSubmitMeta;
optional onSubmitMeta: TSubmitMeta;

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

onSubmitMeta, die Daten, die vom handleSubmit-Handler an die onSubmit-Funktion übergeben werden.

Geerbt von

BaseFormOptions.onSubmitMeta


transform?

ts
optional transform: FormTransform<NoInfer<TFormData>, NoInfer<TOnMount>, NoInfer<TOnChange>, NoInfer<TOnChangeAsync>, NoInfer<TOnBlur>, NoInfer<TOnBlurAsync>, NoInfer<TOnSubmit>, NoInfer<TOnSubmitAsync>, NoInfer<TOnDynamic>, NoInfer<TOnDynamicAsync>, NoInfer<TOnServer>, NoInfer<TSubmitMeta>>;
optional transform: FormTransform<NoInfer<TFormData>, NoInfer<TOnMount>, NoInfer<TOnChange>, NoInfer<TOnChangeAsync>, NoInfer<TOnBlur>, NoInfer<TOnBlurAsync>, NoInfer<TOnSubmit>, NoInfer<TOnSubmitAsync>, NoInfer<TOnDynamic>, NoInfer<TOnDynamicAsync>, NoInfer<TOnServer>, NoInfer<TSubmitMeta>>;

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


validationLogic?

ts
optional validationLogic: ValidationLogicFn;
optional validationLogic: ValidationLogicFn;

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


validators?

ts
optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
optional validators: FormValidators<TFormData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;

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

Eine Liste von Validatoren, die an das Formular übergeben werden.

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.