ra-core/src/form/useApplyInputDefaultValues.ts

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

import { useEffect, useRef } from 'react';
import {
    FieldValues,
    UseFieldArrayReturn,
    useFormContext,
} from 'react-hook-form';
import get from 'lodash/get.js';
import { useRecordContext } from '../controller';
import { InputProps } from './useInput';
import { useWrappedSource } from '../core';

interface StandardInput {
    inputProps: Partial<InputProps> & { source: string };
    isArrayInput?: undefined;
    fieldArrayInputControl?: undefined;
}

interface ArrayInput {
    inputProps: Partial<InputProps> & { source: string };
    isArrayInput: true;
    fieldArrayInputControl: UseFieldArrayReturn<FieldValues, string, 'id'>;
}

type Props = StandardInput | ArrayInput;

/*
 * This hook updates the input with the default value if default value is present
 * and field input is not already populated or dirty
 */
export const useApplyInputDefaultValues = ({
    inputProps,
    isArrayInput,
    fieldArrayInputControl,
}: Props) => {
    const { defaultValue, source, disabled } = inputProps;
    const finalSource = useWrappedSource(source);

    const record = useRecordContext(inputProps);
    const { getValues, resetField, reset, subscribe } = useFormContext();
    const recordValue = get(record, finalSource);
    const formValue = get(getValues(), finalSource);
    const isDirty = useRef<boolean | undefined>(undefined);

    useEffect(() => {
        return subscribe({
            // Even though we only need dirtyFields, we subscribe to values as well to
            // ensure we properly receive dirtyFields updates for newly added items in an ArrayInput
            formState: { values: true, dirtyFields: true },
            callback: ({ dirtyFields }) => {
                isDirty.current = get(dirtyFields ?? {}, finalSource, false);
            },
        });
    }, [finalSource, subscribe]);
    useEffect(() => {
        if (
            defaultValue == null ||
            formValue != null ||
            // When the input is disabled, its value may always be undefined, no matter the default value.
            // This prevents from trying to reset the value indefinitely.
            disabled ||
            // We check strictly for undefined to avoid setting default value
            // when the field is null
            recordValue !== undefined ||
            isDirty.current === true
        ) {
            return;
        }

        // Side note: For Array Input but checked for all to avoid possible regression
        // Since we use get(record, source), if source is like foo.23.bar,
        // this effect will run. However we only want to set the default value
        // for the subfield bar if the record actually has a value for foo.23
        const pathContainsIndex = finalSource
            .split('.')
            .some(pathPart => numericRegex.test(pathPart));
        if (pathContainsIndex) {
            const parentPath = finalSource.split('.').slice(0, -1).join('.');
            const parentValue = get(getValues(), parentPath);
            if (parentValue == null) {
                // the parent is undefined, so we don't want to set the default value
                return;
            }
        }

        if (isArrayInput) {
            if (!fieldArrayInputControl) {
                throw new Error(
                    'useApplyInputDefaultValues: No fieldArrayInputControl passed in props for array input usage'
                );
            }

            // We need to update inputs nested in array using react hook forms
            // own array controller rather then the generic reset to prevent control losing
            // context of the nested inputs
            fieldArrayInputControl.replace(defaultValue);
            // resets the form so that control no longer sees the form as dirty after
            // defaults applied
            reset({}, { keepValues: true });

            return;
        }

        resetField(finalSource, { defaultValue });
    });
};

const numericRegex = /^\d+$/;