Variable FormConst

Type declaration

• • <
        TFieldValues extends FieldValues,
        TContext = any,
        TTransformedValues = TFieldValues,
    >(
        props: FormProviderProps<TFieldValues, TContext, TTransformedValues>,
    ): Element

  • A provider component that propagates the useForm methods to all children components via React Context API. To be used with useFormContext.

    Type Parameters

    • TFieldValues extends FieldValues
    • TContext = any
    • TTransformedValues = TFieldValues

    Parameters

    • props: FormProviderProps<TFieldValues, TContext, TTransformedValues>

      all useForm methods

    Returns Element

    Remarks

    API • Demo

    Example

    function App() {
      const methods = useForm();
      const onSubmit = data => console.log(data);
    
      return (
        <FormProvider {...methods} >
          <form onSubmit={methods.handleSubmit(onSubmit)}>
            <NestedInput />
            <input type="submit" />
          </form>
        </FormProvider>
      );
    }
    
     function NestedInput() {
      const { register } = useFormContext(); // retrieve all hook methods
      return <input {...register("test")} />;
    }
    Copy