Recommended Types
Form Composition API Reference
FormApi Reference
- form.setFieldValue()
- form.getFieldValue()
- form.resetField()
- form.swapFieldValues()
- form.moveFieldValue()
- form.pushFieldValue()
- form.insertFieldValue()
- form.clearFieldValues()
- form.removeFieldValue()
- form.filterFieldValues()
- form.handleSubmit()
- form.reset()
- FormApi
- FormOptions
- FormState
- FormResetOptions
- FormSubmitContext
- FormSubmitInvalidContext
Form Listener API Reference
Field Listener API Reference
FieldListener
Defined in: listeners.public.ts:437
A listener configured on a field.
'change' and 'blur' events from descendant fields propagate to their ancestor field listeners. Use watchFields to receive matching events from other fields.
Example#
listeners: [
{
triggers: ['change', 'blur'],
triggerDebounceMs: 200,
watchFields: ['displayName'],
run: ({ value, formApi }) => {
saveContact({
displayName: formApi.getFieldValue('displayName'),
email: value,
})
},
},
],Extends#
- Listener<FieldListenerTriggers, TFieldData, TFieldValue>
Type Parameters#
TFieldData#
TFieldData
Library-managed. Do not specify explicitly.
TFieldName#
TFieldName
Library-managed. Do not specify explicitly.
TFieldValue#
TFieldValue
Library-managed. Do not specify explicitly.
TFieldError#
TFieldError
Library-managed. Do not specify explicitly.
TFormData#
TFormData
Library-managed. Do not specify explicitly.
TFormErrorTypes#
TFormErrorTypes extends FormErrorTypes
Library-managed. Do not specify explicitly.
Properties#
run#
run: FieldListenerFn<TFieldName, TFieldValue, TFieldError, TFormData, TFormErrorTypes>;Defined in: listeners.public.ts:461
Called when an enabled field trigger occurs.
The return value is ignored. A returned promise is not awaited, and a rejected promise is reported to the console.
Example#
run: ({ value, fieldApi }) => {
const trimmedValue = value.trim()
if (trimmedValue !== value) {
fieldApi.handleChange(trimmedValue)
}
},triggerDebounceMs?#
optional triggerDebounceMs?:
| number
| ListenerDebounceFn<TFieldData, TFieldValue>;Defined in: listeners.public.ts:173
The debounce delay in milliseconds before the listener runs.
A function recalculates the delay for each matching event. Repeated events restart the delay, and the listener receives the latest event context. Values less than or equal to 0 run immediately. 'submit' events always run immediately.
Default#
0Inherited from#
triggers#
triggers: ListenerTriggerOption<FieldListenerTriggers, TFieldData, TFieldValue>[];Defined in: listeners.public.ts:191
The events that can invoke the listener.
The listener runs at most once for an event, even if multiple entries match. An empty array disables the listener.
Example#
triggers: [
'blur',
{
trigger: 'change',
when: ({ formApi }) => formApi.state.isDirty,
},
],Inherited from#
watchFields?#
optional watchFields?: DeepKeys<TFieldData>[];Defined in: listeners.public.ts:482
Other fields whose matching events should also invoke this listener.
The callback still receives this listener's fieldApi and value, not the watched field or its value.
When omitted, the listener receives matching events from its own field and propagated descendant events only.
Example#
watchFields: ['firstName', 'lastName'],