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

FieldValidationPredicateContext.md

108 lines2.0 KB

Defined in: validation.public.ts:443

Current field state available to validator conditions and delay callbacks.

Extends

  • BaseValidationPredicateContext<TFormData, TFieldValue, "field">

Type Parameters

TFormData

TFormData

Library-managed. Do not specify explicitly.

TFieldValue

TFieldValue

Library-managed. Do not specify explicitly.

Properties

fieldApi

fieldApi: AnyFieldApi;

Defined in: validation.public.ts:449

The field being validated.

Overrides

BaseValidationPredicateContext.fieldApi

formApi

formApi: FormApi<TFormData, any>;

Defined in: validation.public.ts:402

The owning form, including its complete values and state.

Inherited from

BaseValidationPredicateContext.formApi

groupApi?

optional groupApi?: undefined;

Defined in: validation.public.ts:447


scope

scope: "field";

Defined in: validation.public.ts:400

Identifies whether value belongs to a form, form group, or field.

Inherited from

BaseValidationPredicateContext.scope

value

value: TFieldValue;

Defined in: validation.public.ts:411

The current value in this validator's scope when the callback is evaluated.

Inherited from

BaseValidationPredicateContext.value