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

FieldApi

Klasse: FieldApi<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:972

Eine Klasse, die die API zur Verwaltung eines Formularfelds darstellt.

Normalerweise müssen Sie keine neue FieldApi-Instanz direkt erstellen. Stattdessen verwenden Sie einen Framework-Hook/-Funktion wie useField oder createField, um eine neue Instanz für Sie zu erstellen, die das reaktive Modell Ihres Frameworks verwendet. Wenn Sie jedoch manuell eine neue Instanz erstellen müssen, können Sie dies tun, indem Sie den Konstruktor new FieldApi aufrufen.

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

Konstruktoren

new FieldApi()

ts
new FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>(opts): FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>

new FieldApi<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync, TFormOnServer, TParentSubmitMeta>(opts): FieldApi<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:1126

Initialisiert eine neue FieldApi-Instanz.

Parameter
opts

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

Gibt zurück

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

Eigenschaften

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:1026

Ein Verweis auf die Formular-API-Instanz.

name
ts
name: DeepKeys<TParentData>;

name: DeepKeys<TParentData>;

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

Der Feldname.

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

options: 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:1058

Die Feldoptionen.

store
ts
store: Derived<FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>>;

store: Derived<FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>>;

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

Der Zustands-Store des Feldes.

timeoutIds
ts
timeoutIds: object;

timeoutIds: object;

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

formListeners
ts
formListeners: Record<ListenerCause, null | Timeout>;

formListeners: Record<ListenerCause, null | Timeout>;

listeners
ts
listeners: Record<ListenerCause, null | Timeout>;

listeners: Record<ListenerCause, null | Timeout>;

validations
ts
validations: Record<ValidationCause, null | Timeout>;

validations: Record<ValidationCause, null | Timeout>;

Zugreifer

state

Get-Signatur

ts
get state(): FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>

get state(): FieldState<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>

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

Der aktuelle Feldzustand.

Gibt zurück

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

Methoden

clearValues()

ts
clearValues(opts?): void

clearValues(opts?): void

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

Löscht alle Werte aus dem Array.

Parameter
opts?

UpdateMetaOptions

Gibt zurück

void

getInfo()
ts
getInfo(): FieldInfo<TParentData>

getInfo(): FieldInfo<TParentData>

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

Ruft das Informations-Objekt des Feldes ab.

Gibt zurück

FieldInfo<TParentData>

getMeta()
ts
getMeta(): FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>

getMeta(): FieldMeta<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>

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

Gibt zurück

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

getValue()
ts
getValue(): TData

getValue(): TData

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

Ruft den aktuellen Feldwert ab.

Gibt zurück

TData

Veraltet

Verwenden Sie stattdessen field.state.value.

handleBlur()
ts
handleBlur(): void

handleBlur(): void

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

Behandelt das Blur-Ereignis.

Gibt zurück

void

handleChange()
ts
handleChange(updater): void

handleChange(updater): void

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

Behandelt das Change-Ereignis.

Parameter
updater

Updater<TData>

Gibt zurück

void

insertValue()
ts
insertValue(
   index, 
   value, 
   opts?): void

insertValue(
   index, 
   value, 
   opts?): void

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

Fügt einen Wert am angegebenen Index ein und verschiebt die nachfolgenden Werte nach rechts.

Parameter
index

number

value

TData extends any[] ? TData<TData>[number] : never

opts?

UpdateMetaOptions

Gibt zurück

void

mount()
ts
mount(): () => void

mount(): () => void

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

Fügt die Feldinstanz dem Formular hinzu.

Gibt zurück

Funktion

Gibt zurück

void

moveValue()
ts
moveValue(
   aIndex, 
   bIndex, 
   opts?): void

moveValue(
   aIndex, 
   bIndex, 
   opts?): void

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

Verschiebt den Wert am ersten angegebenen Index an den zweiten angegebenen Index.

Parameter
aIndex

number

bIndex

number

opts?

UpdateMetaOptions

Gibt zurück

void

parseValueWithSchema()
ts
parseValueWithSchema(schema): 
  | undefined
  | StandardSchemaV1Issue[]

parseValueWithSchema(schema): 
  | undefined
  | StandardSchemaV1Issue[]

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

Parst den Wert des Feldes mit dem angegebenen Schema und gibt Probleme zurück (falls vorhanden). Diese Methode setzt KEINE internen Fehler.

Parameter
schema

StandardSchemaV1<TData, unknown>

Das Standard-Schema, mit dem der Wert dieses Feldes geparst werden soll.

Gibt zurück

| undefined | StandardSchemaV1Issue[]

parseValueWithSchemaAsync()
ts
parseValueWithSchemaAsync(schema): Promise<
  | undefined
| StandardSchemaV1Issue[]>

parseValueWithSchemaAsync(schema): Promise<
  | undefined
| StandardSchemaV1Issue[]>

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

Parst den Wert des Feldes mit dem angegebenen Schema und gibt Probleme zurück (falls vorhanden). Diese Methode setzt KEINE internen Fehler.

Parameter
schema

StandardSchemaV1<TData, unknown>

Das Standard-Schema, mit dem der Wert dieses Feldes geparst werden soll.

Gibt zurück

Promise< | undefined | StandardSchemaV1Issue[]>

pushValue()
ts
pushValue(value, opts?): void

pushValue(value, opts?): void

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

Fügt einen neuen Wert zum Feld hinzu.

Parameter
value

TData extends any[] ? TData<TData>[number] : never

opts?

UpdateMetaOptions

Gibt zurück

void

removeValue()
ts
removeValue(index, opts?): void

removeValue(index, opts?): void

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

Löscht einen Wert am angegebenen Index.

Parameter
index

number

opts?

UpdateMetaOptions

Gibt zurück

void

replaceValue()
ts
replaceValue(
   index, 
   value, 
   opts?): void

replaceValue(
   index, 
   value, 
   opts?): void

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

Ersetzt einen Wert am angegebenen Index.

Parameter
index

number

value

TData extends any[] ? TData<TData>[number] : never

opts?

UpdateMetaOptions

Gibt zurück

void

setErrorMap()
ts
setErrorMap(errorMap): void

setErrorMap(errorMap): void

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

Aktualisiert die errorMap des Feldes.

Parameter
errorMap

ValidationErrorMap<UnwrapFieldValidateOrFn<TName, TOnMount, TFormOnMount>, UnwrapFieldValidateOrFn<TName, TOnChange, TFormOnChange>, UnwrapFieldAsyncValidateOrFn<TName, TOnChangeAsync, TFormOnChangeAsync>, UnwrapFieldValidateOrFn<TName, TOnBlur, TFormOnBlur>, UnwrapFieldAsyncValidateOrFn<TName, TOnBlurAsync, TFormOnBlurAsync>, UnwrapFieldValidateOrFn<TName, TOnSubmit, TFormOnSubmit>, UnwrapFieldAsyncValidateOrFn<TName, TOnSubmitAsync, TFormOnSubmitAsync>, UnwrapFieldValidateOrFn<TName, TOnDynamic, TFormOnDynamic>, UnwrapFieldAsyncValidateOrFn<TName, TOnDynamicAsync, TFormOnDynamicAsync>>

Gibt zurück

void

setMeta()
ts
setMeta(updater): void

setMeta(updater): void

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

Legt die Metadaten des Feldes fest.

Parameter
updater

Updater<FieldMetaBase<TParentData, TName, TData, TOnMount, TOnChange, TOnChangeAsync, TOnBlur, TOnBlurAsync, TOnSubmit, TOnSubmitAsync, TOnDynamic, TOnDynamicAsync, TFormOnMount, TFormOnChange, TFormOnChangeAsync, TFormOnBlur, TFormOnBlurAsync, TFormOnSubmit, TFormOnSubmitAsync, TFormOnDynamic, TFormOnDynamicAsync>>

Gibt zurück

void

setValue()
ts
setValue(updater, options?): void

setValue(updater, options?): void

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

Legt den Feldwert fest und führt den change-Validator aus.

Parameter
updater

Updater<TData>

options?

UpdateMetaOptions

Gibt zurück

void

swapValues()
ts
swapValues(
   aIndex, 
   bIndex, 
   opts?): void

swapValues(
   aIndex, 
   bIndex, 
   opts?): void

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

Vertauscht die Werte an den angegebenen Indizes.

Parameter
aIndex

number

bIndex

number

opts?

UpdateMetaOptions

Gibt zurück

void

update()
ts
update(opts): void

update(opts): void

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

Aktualisiert die Feldinstanz mit neuen Optionen.

Parameter
opts

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

Gibt zurück

void

validate()
ts
validate(cause, opts?): unknown[] | Promise<unknown[]>

validate(cause, opts?): unknown[] | Promise<unknown[]>

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

Validiert den Feldwert.

Parameter
cause

ValidationCause

opts?
skipFormValidation?

boolean

Gibt zurück

unknown[] | Promise<unknown[]>

Auf GitHub bearbeiten
JavaScript Referenz
Klassen / FormApi
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.