Circle V2 API Docs
    Preparing search index...

    Type Alias UseFormRegister<TFieldValues>

    UseFormRegister: <
        TFieldName extends FieldPath<TFieldValues> = FieldPath<TFieldValues>,
    >(
        name: TFieldName,
        options?: RegisterOptions<TFieldValues, TFieldName>,
    ) => UseFormRegisterReturn<TFieldName>

    Register field into hook form with or without the actual DOM ref. You can invoke register anywhere in the component including at useEffect.

    Type Parameters

    Type Declaration

    APIDemoVideo

    // Register HTML native input
    <input {...register("input")} />
    <select {...register("select")} />

    // Register options
    <textarea {...register("textarea", { required: "This is required.", maxLength: 20 })} />
    <input type="number" {...register("name2", { valueAsNumber: true })} />
    <input {...register("name3", { deps: ["name2"] })} />

    // Register custom field at useEffect
    useEffect(() => {
    register("name4");
    register("name5", { value: "hiddenValue" });
    }, [register])

    // Register without ref
    const { onChange, onBlur, name } = register("name6")
    <input onChange={onChange} onBlur={onBlur} name={name} />