useInitialize

React custom hook for setting initial values on a form.

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

export function useInitialize<T extends z.ZodTypeAny>(
  options: {
    values?: DeepPartial<z.input<T>>
    parsedValues?: z.output<T>
    keepSubmitSucceeded?: boolean
  },
  deps: DependencyList = [options.values, options.parsedValues]
): void

You must pass an explicit schema type for T unless you use the useInitialize returned by createZodForm.

Any time deps is not shallow equal to its value on the previous render (similar to useEffect), the form is reinitialized.

If keepSubmitSucceeded is true, the submitSucceeded property won't be cleared on reinitialize.