Framework
Version
API-Referenz

FieldApiOptions

Interface: FieldApiOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>

Definiert in: packages/form-core/src/FieldApi.ts:485

Ein Objekttyp, der die erforderlichen Optionen für die FieldApi-Klasse repräsentiert.

Erbt von

  • FieldOptions<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>

Typparameter

TParentData

TName erweitert DeepKeys<TParentData>

TData erweitert DeepValue<TParentData, TName>

TOnMount erweitert undefined | FieldValidateOrFn<TParentData, TName, TData>

TOnChange erweitert undefined | FieldValidateOrFn<TParentData, TName, TData>

TOnChangeAsync erweitert undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

TOnBlur erweitert undefined | FieldValidateOrFn<TParentData, TName, TData>

TOnBlurAsync erweitert undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

TOnSubmit erweitert undefined | FieldValidateOrFn<TParentData, TName, TData>

TOnSubmitAsync erweitert undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

TOnDynamic erweitert undefined | FieldValidateOrFn<TParentData, TName, TData>

TOnDynamicAsync erweitert undefined | FieldAsyncValidateOrFn<TParentData, TName, TData>

TFormOnMount erweitert undefined | FormValidateOrFn<TParentData>

TFormOnChange erweitert undefined | FormValidateOrFn<TParentData>

TFormOnChangeAsync erweitert undefined | FormAsyncValidateOrFn<TParentData>

TFormOnBlur erweitert undefined | FormValidateOrFn<TParentData>

TFormOnBlurAsync erweitert undefined | FormAsyncValidateOrFn<TParentData>

TFormOnSubmit erweitert undefined | FormValidateOrFn<TParentData>

TFormOnSubmitAsync erweitert undefined | FormAsyncValidateOrFn<TParentData>

TFormOnDynamic erweitert undefined | FormValidateOrFn<TParentData>

TFormOnDynamicAsync erweitert undefined | FormAsyncValidateOrFn<TParentData>

TFormOnServer extends undefined | FormAsyncValidateOrFn<TParentData>

TParentSubmitMeta

Eigenschaften

asyncAlways?

ts
optional asyncAlways: boolean;
optional asyncAlways: boolean;

Definiert in: packages/form-core/src/FieldApi.ts:426

Wenn true, führe asynchrone Validierung immer aus, auch wenn während der synchronen Validierung Fehler auftreten.

Geerbt von

FieldOptions.asyncAlways


asyncDebounceMs?

ts
optional asyncDebounceMs: number;
optional asyncDebounceMs: number;

Definiert in: packages/form-core/src/FieldApi.ts:422

Die Standardzeit für das Debouncing der asynchronen Validierung, wenn kein spezifischerer Debounce-Zeitwert übergeben wird.

Geerbt von

FieldOptions.asyncDebounceMs


defaultMeta?

ts
optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;
optional defaultMeta: Partial<FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, any, any, any, any, any, any, any, any, any>>;

Definiert in: packages/form-core/src/FieldApi.ts:447

Ein optionales Objekt mit Standardmetadaten für das Feld.

Geerbt von

FieldOptions.defaultMeta


defaultValue?

ts
optional defaultValue: NoInfer<TData>;
optional defaultValue: NoInfer<TData>;

Definiert in: packages/form-core/src/FieldApi.ts:418

Ein optionaler Standardwert für das Feld.

Geerbt von

FieldOptions.defaultValue


disableErrorFlat?

ts
optional disableErrorFlat: boolean;
optional disableErrorFlat: boolean;

Definiert in: packages/form-core/src/FieldApi.ts:479

Deaktiviert die flat(1)-Operation auf field.errors. Dies ist nützlich, wenn Sie die Fehlerstruktur beibehalten möchten. Für die meisten Anwendungsfälle nicht empfohlen.

Geerbt von

FieldOptions.disableErrorFlat


form

ts
form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;
form: FormApi<TParentData, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>;

Definiert in: packages/form-core/src/FieldApi.ts:549


listeners?

ts
optional listeners: FieldListeners<TParentData, TName, TData>;
optional listeners: FieldListeners<TParentData, TName, TData>;

Definiert in: packages/form-core/src/FieldApi.ts:475

Eine Liste von Listenern, die an die entsprechenden Ereignisse angehängt werden.

Geerbt von

FieldOptions.listeners


name

ts
name: TName;
name: TName;

Definiert in: packages/form-core/src/FieldApi.ts:414

Der Feldname. Der Typ ist DeepKeys<TParentData>, um sicherzustellen, dass Ihr Name ein tiefer Schlüssel des übergeordneten Datensatzes ist.

Geerbt von

FieldOptions.name


validators?

ts
optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;
optional validators: FieldValidators<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync>;

Definiert in: packages/form-core/src/FieldApi.ts:430

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

Geerbt von

FieldOptions.validators

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.