@matthew.ngo/reform/dist/features/field-array/useFieldArrayHelpers.d.ts

A flexible and powerful React form management library with advanced validation, state observation, and multi-group support

import { UseFormReturn } from "react-hook-form";
import { FieldArrayHelpers } from "./types";
import { FormGroup } from '../../core/form/form-groups';
/**
 * Props for the useFieldArrayHelpers hook
 *
 * @template T - The type of form data within each group
 */
interface UseFieldArrayHelpersProps<T> {
    /** React Hook Form methods for the form */
    methods: UseFormReturn<{
        groups: FormGroup<T>[];
    }>;
    /** Optional callback triggered when array fields are modified */
    onChange?: (groups: FormGroup<T>[]) => void;
}
/**
 * Hook that provides utilities for managing array fields within form groups
 *
 * This hook enables manipulation of array fields inside Reform groups, providing
 * methods similar to React Hook Form's useFieldArray but adapted for the Reform
 * group structure.
 *
 * @template T - The type of form data within each group
 */
export declare const useFieldArrayHelpers: <T extends Record<string, any>>({ methods, onChange, }: UseFieldArrayHelpersProps<T>) => FieldArrayHelpers<T>;
export {};