GTKX

API Reference / @gtkx/forms / useFormState

Function: useFormState() ​

useFormState<TFieldValues, TTransformedValues>(props?): UseFormStateReturn<TFieldValues>

Subscribes to form state with re-renders isolated to this hook. Optionally scope to specific field names to minimize re-render surface.

Type Parameters ​

TFieldValues ​

TFieldValues extends FieldValues = FieldValues

TTransformedValues ​

TTransformedValues = TFieldValues

Parameters ​

props? ​

Partial<{ control?: Control<TFieldValues, any, TTransformedValues>; disabled?: boolean; exact?: boolean; name?: Path<TFieldValues> | Path<TFieldValues>[] | readonly Path<TFieldValues>[]; }>

Returns ​

UseFormStateReturn<TFieldValues>

See ​

API

Example ​

tsx
const { errors, isDirty } = useFormState({ control, name: "email" });