useArrayField

React custom hook for subscribing to the value and validation state of an array form field and getting methods to programmatically manipulate it.

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

export function useArrayField(path): UseArrayFieldProps`

path may be a FieldPath. If you cast to TypedUseArrayField or use the useArrayField returned from createZodForm, path may be a pathstring or path array.

The full method signature extracts the type of the subschema at the given path, and should produce a TS error if the path is invalid, not array valued, or doesn't exist in the schema.

Returns UseArrayFieldProps

An object containing the following properties. Causes a rerender when any of these properties changes.

• elements - an array of FieldPaths for each element of the array
• error - the validation error message, if any
• dirty - whether the value is not equal to initialValue
• pristine - opposite of dirty
• valid - whether the value is valid
• invalid - oppposite of valid
• touched - whether the field has been blurred or the form submitted
• visited - whether the field has been focused
• setMeta - method to set the FieldMeta for this field
• setValue - method to set the value for this field
• setParsedValue - method to set the parsed value for this field
• insertParsed - method to insert a parsed value into the array
• insert - method to insert a value into the array
• move - method to move a value from one index to another
• pop - method to remove the last value from the array
• pushParsed - method to add a parsed value to the end of the array
• push - method to add a value to the end of the array
• remove - method to remove a value at an index
• removeAll - method to remove all values
• spliceParsed - method to remove and/or insert parsed values, like Array.splice
• splice - method to remove and/or insert values, like Array.splice
• swap - method to swap values at two indices
• unshiftParsed - method to add a parsed value to the beginning of the array
• unshift - method to add a value to the beginning of the array