GTKX

API Reference / @gtkx/forms / useWatch

Function: useWatch() ​

Call Signature ​

useWatch<TFieldValues, TTransformedValues>(props): DeepPartialSkipArrayKey<TFieldValues>

Watches the entire form; re-renders when any value changes.

Type Parameters ​

TFieldValues ​

TFieldValues extends FieldValues = FieldValues

TTransformedValues ​

TTransformedValues = TFieldValues

Parameters ​

props ​

compute? ​

undefined

control? ​

Control<TFieldValues, any, TTransformedValues>

defaultValue? ​

DeepPartialSkipArrayKey<TFieldValues>

disabled? ​

boolean

exact? ​

boolean

name? ​

undefined

Returns ​

DeepPartialSkipArrayKey<TFieldValues>

Call Signature ​

useWatch<TFieldValues, TFieldName, TTransformedValues>(props): FieldPathValue<TFieldValues, TFieldName>

Watches a single field by name.

Type Parameters ​

TFieldValues ​

TFieldValues extends FieldValues = FieldValues

TFieldName ​

TFieldName extends string = FieldPath<TFieldValues>

TTransformedValues ​

TTransformedValues = TFieldValues

Parameters ​

props ​

compute? ​

undefined

control? ​

Control<TFieldValues, any, TTransformedValues>

defaultValue? ​

FieldPathValue<TFieldValues, TFieldName>

disabled? ​

boolean

exact? ​

boolean

name ​

TFieldName

Returns ​

FieldPathValue<TFieldValues, TFieldName>

Call Signature ​

useWatch<TFieldValues, TTransformedValues, TComputeValue>(props): TComputeValue

Watches the entire form and derives a value via compute.

Type Parameters ​

TFieldValues ​

TFieldValues extends FieldValues = FieldValues

TTransformedValues ​

TTransformedValues = TFieldValues

TComputeValue ​

TComputeValue = unknown

Parameters ​

props ​

compute ​

(formValues) => TComputeValue

control? ​

Control<TFieldValues, any, TTransformedValues>

defaultValue? ​

DeepPartialSkipArrayKey<TFieldValues>

disabled? ​

boolean

exact? ​

boolean

name? ​

undefined

Returns ​

TComputeValue

Call Signature ​

useWatch<TFieldValues, TFieldName, TTransformedValues, TComputeValue>(props): TComputeValue

Watches a single field and derives a value via compute.

Type Parameters ​

TFieldValues ​

TFieldValues extends FieldValues = FieldValues

TFieldName ​

TFieldName extends string = FieldPath<TFieldValues>

TTransformedValues ​

TTransformedValues = TFieldValues

TComputeValue ​

TComputeValue = unknown

Parameters ​

props ​

compute ​

(fieldValue) => TComputeValue

control? ​

Control<TFieldValues, any, TTransformedValues>

defaultValue? ​

FieldPathValue<TFieldValues, TFieldName>

disabled? ​

boolean

exact? ​

boolean

name ​

TFieldName

Returns ​

TComputeValue

Call Signature ​

useWatch<TFieldValues, TFieldNames, TTransformedValues>(props): { [K in string | number | symbol]: PathValueImpl<TFieldValues, TFieldNames[K] & Path<TFieldValues>> }

Watches multiple fields by name array.

Type Parameters ​

TFieldValues ​

TFieldValues extends FieldValues = FieldValues

TFieldNames ​

TFieldNames extends readonly FieldPath<TFieldValues>[] = readonly FieldPath<TFieldValues>[]

TTransformedValues ​

TTransformedValues = TFieldValues

Parameters ​

props ​

compute? ​

undefined

control? ​

Control<TFieldValues, any, TTransformedValues>

defaultValue? ​

DeepPartialSkipArrayKey<TFieldValues>

disabled? ​

boolean

exact? ​

boolean

name ​

readonly [TFieldNames]

Returns ​

{ [K in string | number | symbol]: PathValueImpl<TFieldValues, TFieldNames[K] & Path<TFieldValues>> }

Call Signature ​

useWatch<TFieldValues, TFieldNames, TTransformedValues, TComputeValue>(props): TComputeValue

Watches multiple fields and derives a value via compute.

Type Parameters ​

TFieldValues ​

TFieldValues extends FieldValues = FieldValues

TFieldNames ​

TFieldNames extends readonly FieldPath<TFieldValues>[] = readonly FieldPath<TFieldValues>[]

TTransformedValues ​

TTransformedValues = TFieldValues

TComputeValue ​

TComputeValue = unknown

Parameters ​

props ​

compute ​

(fieldValue) => TComputeValue

control? ​

Control<TFieldValues, any, TTransformedValues>

defaultValue? ​

DeepPartialSkipArrayKey<TFieldValues>

disabled? ​

boolean

exact? ​

boolean

name ​

readonly [TFieldNames]

Returns ​

TComputeValue

Call Signature ​

useWatch<TFieldValues>(): DeepPartialSkipArrayKey<TFieldValues>

Watches the entire form; reads control from FormProvider context.

Type Parameters ​

TFieldValues ​

TFieldValues extends FieldValues = FieldValues

Returns ​

DeepPartialSkipArrayKey<TFieldValues>