Interface: FieldApiOptions<TFieldData, TFieldName, TFieldValue, TFieldValidators, TGroupFieldError, TFormData, TFormErrorTypes>#

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

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

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

listeners?#

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

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

name#

name: TFieldName;

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

validators?#

optional validators?: TFieldValidators;

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