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

ValidationTriggerConfig.md

69 lines1.5 KB

Defined in: validation.public.ts:506

A change or blur event with an optional condition for running validation.

Type Parameters

TFormData

TFormData

Library-managed. Do not specify explicitly.

TValue

TValue

Library-managed. Do not specify explicitly.

TTrigger

TTrigger extends ValidatorTrigger = ValidatorTrigger

Library-managed. Do not specify explicitly.

TScope

TScope extends ValidatorScope = ValidatorScope

Library-managed. Do not specify explicitly.

Properties

trigger

trigger: TTrigger;

Defined in: validation.public.ts:513

The event to match before evaluating when.


when?

optional when?: 
  | boolean
| ValidationPredicateFn<TFormData, TValue, TScope>;

Defined in: validation.public.ts:522

Whether this trigger enables validation when its event occurs.

Pass a boolean to enable or disable it, or pass a function that returns true to enable it for the current event.

Default

true