ra-core/dist/form/Form.js

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

import * as React from 'react';
import { FormProvider, } from 'react-hook-form';
import { FormGroupsProvider } from "./groups/FormGroupsProvider.js";
import { useRecordContext, OptionalRecordContextProvider, } from "../controller/index.js";
import { SourceContextProvider, useResourceContext, } from "../core/index.js";
import { useCanBlock } from "../routing/index.js";
import { WarnWhenUnsavedChanges } from "./WarnWhenUnsavedChanges.js";
import { useAugmentedForm } from "./useAugmentedForm.js";
/**
 * Creates a form element, initialized with the current record, calling the saveContext on submit
 *
 * Wrapper around react-hook-form's useForm, FormContextProvider, and <form>.
 * Also sets up a FormGroupContext, and handles submission validation.
 *
 * @example
 *
 * const MyForm = ({ record, defaultValues, validate }) => (
 *    <Form record={record} defaultValues={defaultValues} validate={validate}>
 *        <Stack>
 *            <TextInput source="title" />
 *            <SaveButton />
 *        </Stack>
 *    </Form>
 * );
 *
 * @typedef {Object} Props the props you can use
 * @prop {Object} defaultValues
 * @prop {Function} validate
 * @prop {Function} save
 *
 * @see useForm
 * @see FormGroupContext
 *
 * @link https://react-hook-form.com/docs/useformcontext
 */
export function Form(props) {
    const { children, id, className, noValidate = false, formRootPathname, warnWhenUnsavedChanges, WarnWhenUnsavedChangesComponent = WarnWhenUnsavedChanges, } = props;
    const record = useRecordContext(props);
    const resource = useResourceContext(props);
    const { form, formHandleSubmit } = useAugmentedForm(props);
    const sourceContext = React.useMemo(() => ({
        getSource: (source) => source,
        getLabel: (source) => `resources.${resource}.fields.${source}`,
    }), [resource]);
    const canBlock = useCanBlock();
    if (warnWhenUnsavedChanges &&
        !canBlock &&
        process.env.NODE_ENV === 'development') {
        console.error('Cannot use the warnWhenUnsavedChanges feature outside of a DataRouter. ' +
            'The warnWhenUnsavedChanges feature is disabled. ' +
            'Remove the warnWhenUnsavedChanges prop or convert your custom router to a Data Router.');
    }
    return (React.createElement(OptionalRecordContextProvider, { value: record },
        React.createElement(SourceContextProvider, { value: sourceContext },
            React.createElement(FormProvider, { ...form },
                React.createElement(FormGroupsProvider, null,
                    React.createElement("form", { onSubmit: formHandleSubmit, noValidate: noValidate, id: id, className: className }, children),
                    warnWhenUnsavedChanges && canBlock && (React.createElement(WarnWhenUnsavedChangesComponent, { enable: true, formRootPathName: formRootPathname, formControl: form.control })))))));
}
//# sourceMappingURL=Form.js.map