createZodForm

Creates a form for a Zod schema

import { createZodForm } from '@jcoreio/zod-forms'

createZodForm<T extends z.ZodTypeAny>(options: { schema: T }): ZodForm<T>

Requirements

If you want to use .transforms in schema, you must declare them via zod-invertible so that it's possible to format final values into raw values; otherwise createZodForm will throw an error.

Returns ZodForm<T>

An object with the following properties:

• root - the root FieldPath
• get - shortcut for root.get(...)
• FormProvider - React component to provide form context to its descendants
• useFormContext bound to schema type T
• useFormStatus bound to schema type T
• useFormValues bound to schema type T
• useInitialize bound to schema type T
• useSubmit bound to schema type T
• useArrayField bound to schema type T
• useField bound to schema type T
• useHtmlField bound to schema type T

FormProvider

A React component to provide form context to its descendants.

const { FormProvider } = createZodForm({ schema })

Example

function MyForm() {
  return (
    <FormProvider>
      <MyFormContent />
    </FormProvider>
  )
}