GTKX

API Reference / @gtkx/forms / FormProvider

Variable: FormProvider ​

const FormProvider: <TFieldValues, TContext, TTransformedValues>({ children, watch, getValues, getErrors, getFieldState, setError, clearErrors, setValue, setValues, trigger, formState, resetField, reset, resetDefaultValues, handleSubmit, unregister, control, register, setFocus, subscribe, }) => React.JSX.Element

Provides all useForm methods to the component tree via React Context. Pair with useFormContext to consume them in any descendant.

Type Parameters ​

TFieldValues ​

TFieldValues extends FieldValues

TContext ​

TContext = any

TTransformedValues ​

TTransformedValues = TFieldValues

Parameters ​

{ children, watch, getValues, getErrors, getFieldState, setError, clearErrors, setValue, setValues, trigger, formState, resetField, reset, resetDefaultValues, handleSubmit, unregister, control, register, setFocus, subscribe, } ​

FormProviderProps<TFieldValues, TContext, TTransformedValues>

Returns ​

React.JSX.Element

See ​

API

Example ​

tsx
<FormProvider {...methods}>
  <form onSubmit={methods.handleSubmit(onSubmit)}>{children}</form>
</FormProvider>