ra-core/src/controller/input/useArrayInput.ts

Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React

import { useContext, useMemo } from 'react';
import { ArrayInputContext, ArrayInputContextValue } from './ArrayInputContext';

/**
 * A hook to access an array input methods as provided by react-hook-form.
 * Useful to create custom array input iterators.
 * @see {ArrayInput}
 * @see https://react-hook-form.com/docs/usefieldarray
 */
export const useArrayInput = (
    props?: Partial<ArrayInputContextValue>
): ArrayInputContextValue => {
    const context = useContext(ArrayInputContext);
    const memo = useMemo(
        () =>
            ({
                append: props?.append,
                fields: props?.fields,
                insert: props?.insert,
                move: props?.move,
                prepend: props?.prepend,
                remove: props?.remove,
                replace: props?.replace,
                swap: props?.swap,
                update: props?.update,
            }) as ArrayInputContextValue,
        [props]
    );

    if (props?.fields) {
        return memo;
    }
    if (!context) {
        throw new Error(
            'useArrayInput must be used inside an ArrayInputContextProvider'
        );
    }

    return context;
};