Hero Hook Form API v2.5.1

Hero Hook Form API / useInferredForm

Function: useInferredForm()

useInferredForm<T>(schema, fields, options?): UseFormReturn<T>

Defined in: hooks/useInferredForm.ts:80 

Hook for creating a form instance from an inferred form configuration.

Type Parameters

T

T extends FieldValues

The form data type

Parameters

schema

any

Zod schema for validation

fields

ZodFormFieldConfig<T>[]

Field configurations

options?

UseInferredFormOptions<T> = {}

Form options

Returns

UseFormReturn<T>

React Hook Form instance

Description

Creates a React Hook Form instance with Zod validation resolver from a type-inferred form configuration. Automatically sets up validation based on the provided schema and fields.

Example

import { useInferredForm, defineInferredForm, field } from "@rachelallyson/hero-hook-form";
 
const formConfig = defineInferredForm({
  name: field.string("Name").min(2),
  email: field.email("Email"),
});
 
function MyForm() {
  const form = useInferredForm(
    formConfig.schema,
    formConfig.fields,
    { mode: "onBlur" }
  );
 
  return (
    <form onSubmit={form.handleSubmit(handleSubmit)}>
      {/* form fields */}
    </form>
  );
}

See

• defineInferredForm for creating type-inferred form configurations
• useTypeInferredForm for alternative API