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

FormGroupValidationPredicateContext.md

107 lines2.1 KB

Defined in: validation.public.ts:430

Current form group state available to validator conditions and delay callbacks.

Extends

  • BaseValidationPredicateContext<any, TGroupValue, "group">

Type Parameters

TGroupValue

TGroupValue

Library-managed. Do not specify explicitly.

Properties

fieldApi?

optional fieldApi?: AnyFieldApi;

Defined in: validation.public.ts:409

The field associated with the validation event, when available.

For form and group validators, this is the field that triggered the validation. For field validators, this is the field being validated.

Inherited from

BaseValidationPredicateContext.fieldApi

formApi

formApi: FormApi<any, any>;

Defined in: validation.public.ts:402

The owning form, including its complete values and state.

Inherited from

BaseValidationPredicateContext.formApi

groupApi

groupApi: FormGroupApi<any, any, TGroupValue, any, any>;

Defined in: validation.public.ts:434

The form group whose value is being validated.


scope

scope: "group";

Defined in: validation.public.ts:400

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

Inherited from

BaseValidationPredicateContext.scope

value

value: TGroupValue;

Defined in: validation.public.ts:411

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

Inherited from

BaseValidationPredicateContext.value