Circle V2 API Docs
    Preparing search index...

    Function useFormState

    • This custom hook allows you to subscribe to each form state, and isolate the re-render at the custom hook level. It has its scope in terms of form state subscription, so it would not affect other useFormState and useForm. Using this hook can reduce the re-render impact on large and complex form application.

      Type Parameters

      Parameters

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

        include options on specify fields to subscribe. UseFormStateReturn

      Returns UseFormStateReturn<TFieldValues>

      APIDemo

      function App() {
      const { register, handleSubmit, control } = useForm({
      defaultValues: {
      firstName: "firstName"
      }});
      const { dirtyFields } = useFormState({
      control
      });
      const onSubmit = (data) => console.log(data);

      return (
      <form onSubmit={handleSubmit(onSubmit)}>
      <input {...register("firstName")} placeholder="First Name" />
      {dirtyFields.firstName && <p>Field is dirty.</p>}
      <input type="submit" />
      </form>
      );
      }