Skip to content

watch

Subscribe to input changes

watch: (names?: string | string[] | (data, options) => void) => unknown

This method will watch specified inputs and return their values. It is useful to render input value and for determining what to render by condition.

Props

TypeDescriptionExampleReturn
stringWatch input value by name (similar to lodash get function)watch('inputName')
watch('inputName', 'value')
any
string[]Watch multiple inputswatch(['inputName1'])
watch(['field1'], { field1: '1' })
unknown[]
undefinedWatch all inputswatch()
watch(undefined, { field: '1' })
{[key:string]: unknown}
(data: unknown, { name: string, type: string }) => voidWatch all inputs and invoke a callbackwatch((data, { name, type }) => console.log(data, name, type)){ unsubscribe: () => void }

Rules

  • When defaultValue is not defined, the first render of watch will return undefined because it is called before register. It's recommend to provide defaultValues at useForm to avoid this behaviour, but you can set the inline defaultValue as the second argument.

  • When both defaultValue and defaultValues are supplied, defaultValue will be returned.

  • This API will trigger re-render at the root of your app or form, consider using a callback or the useWatch api if you are experiencing performance issues.

  • watch result is optimised for render phase instead of useEffect's deps, to detect value update you may want to use an external custom hook for value comparison.

Examples

Video

The following video tutorial demonstrates watch API.

Thank you for your support

If you find React Hook Form to be useful in your project, please consider to star and support it.

Edit