Framework
Version
API-Referenz

FieldOptions

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

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

Ein Objekttyp, der die Optionen für ein Feld in einem Formular darstellt.

Erweitert von

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>

Eigenschaften

asyncAlways?

ts
optional asyncAlways: boolean;
optional asyncAlways: boolean;

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

Wenn true, führe immer eine asynchrone Validierung durch, auch wenn während der synchronen Validierung Fehler ausgegeben wurden.


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 keine spezifischere Debouncing-Zeit angegeben ist.


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 Metadaten für das Feld.


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.


disableErrorFlat?

ts
optional disableErrorFlat: boolean;
optional disableErrorFlat: boolean;

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

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


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.


name

ts
name: TName;
name: TName;

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

Der Feldname. Der Typ wird DeepKeys<TParentData> sein, um sicherzustellen, dass dein Name ein tiefer Schlüssel des Elterndatensatzes ist.


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 sollen.

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.