This method is introduced in react-hook-form (v7.25.0) to return individual field state. It's useful in case you are trying to retrieve nested field state in a typesafe way.

Props

Return

Rules

• name need to match registered field name.

  Copy

  getFieldState('test'); getFieldState('test'); // ✅ register input and return field state getFieldState('non-existent-name'); // ❌ will return state as false and error as undefined

  getFieldState('test');
  
  getFieldState('test'); // ✅ register input and return field state
  getFieldState('non-existent-name'); // ❌ will return state as false and error as undefined 
  
  

• formState will need to subscribed.

  Copy

  const { register, formState: { isDirty } } = useForm() register('test'); getFieldState('test'); // ✅ register input and return field state --------------------------- // This is valid with useFormState as well const { isDirty } = useFormState(); register('test'); getFieldState('test'); // ✅ register input and return field state

  const { register, formState: { isDirty } } = useForm()
  register('test');
  getFieldState('test'); // ✅ register input and return field state
  
  ---------------------------
  
  // This is valid with useFormState as well
  const { isDirty } = useFormState();
  
  register('test');
  getFieldState('test'); // ✅ register input and return field state
  
  
  Copy

  const { register } = useForm() register('test'); getFieldState('test'); // ❌ formState is subscribed and no re-render to inform state update --------------------------- const { register, formState } = useForm() getFieldState('test', formState); // ✅ register input and return field state

  const { register } = useForm()
  register('test');
  getFieldState('test'); // ❌ formState is subscribed and no re-render to inform state update
  
  ---------------------------
  
  const { register, formState } = useForm()
  getFieldState('test', formState); // ✅ register input and return field state
  
  

Examples

import * as React from "react";
import { useForm } from "react-hook-form";

export default function App() {
  const {
    register,
    getFieldState,
    formState: { isDirty, isValid }
  } = useForm({
    mode: "onChange",
    defaultValues: {
      firstName: ""
    }
  });

  // you can invoke before render or within the render function
  const fieldState = getFieldState("firstName");

  return (
    <form>
      <input {...register("firstName", { required: true })} />
      <p>{getFieldState("firstName").isDirty && "dirty"}</p>
      <p>{getFieldState("firstName").isTouched && "touched"}</p>
      <button type="button" onClick={() => console.log(getFieldState("firstName"))}>
        field state
      </button>
    </form>
  );
}