Skip to content
Source
Sign inSign up
TanStack/form
Open History to see the last commit

FieldApiOptions.md

91 lines2.1 KB

Defined in: FieldApi/FieldApi.public.ts:206

Type Parameters

TFieldData

TFieldData

TFieldName

TFieldName

TFieldValue

TFieldValue

TFieldValidators

TFieldValidators extends FieldValidators<TFieldData, TFieldName, TFieldValue>

TGroupFieldError

TGroupFieldError

TFormData

TFormData

TFormErrorTypes

TFormErrorTypes extends FormErrorTypes

Properties

errorBoundary?

optional errorBoundary?: boolean;

Defined in: FieldApi/FieldApi.public.ts:224

Route descendant field errors from form and form group validators to this field.


errorVisibility?

optional errorVisibility?: ErrorVisibility<TFormData, TFormErrorTypes>;

Defined in: FieldApi/FieldApi.public.ts:220


listeners?

optional listeners?: FieldListeners<TFieldData, TFieldName, TFieldValue, FallbackToValidationIssue<
  | ExtractValidatorFieldError<NoInfer<TFieldValidators>, FieldValidators<any, any, any>>
  | unknown extends TGroupFieldError ? never : TGroupFieldError
| ExtractFormFieldError<TFormErrorTypes>>, TFormData, TFormErrorTypes>;

Defined in: FieldApi/FieldApi.public.ts:226


name

name: TFieldName;

Defined in: FieldApi/FieldApi.public.ts:219


validators?

optional validators?: TFieldValidators;

Defined in: FieldApi/FieldApi.public.ts:225