Hero Hook Form API / useLazyFieldRegistration

Function: useLazyFieldRegistration()

useLazyFieldRegistration<TFieldValues>(fieldName, shouldRegister, defaultValue?, rules?): object

Defined in: hooks/useLazyFieldRegistration.ts:18

Hook for lazy field registration to reduce initial memory usage.

This hook registers fields only when they become active (e.g., when a condition is met), preventing the memory overhead of always-registered fields while avoiding register/unregister cycles that cause memory leaks in Cypress.

Type Parameters

TFieldValues

TFieldValues extends FieldValues

Parameters

fieldName

FieldPath<TFieldValues>

The field name to potentially register

shouldRegister

() => boolean

Function that determines if the field should be registered

defaultValue?

any

Default value for the field when registered

rules?

any

Validation rules for the field

Returns

object

currentValue

currentValue: undefined

isRegistered

isRegistered: boolean