Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reset submission error when the field is changed #5962

Merged
merged 3 commits into from
Mar 8, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions packages/ra-core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -55,6 +55,7 @@
"peerDependencies": {
"connected-react-router": "^6.5.2",
"final-form": "^4.18.5",
"final-form-submit-errors": "^0.1.2",
"react": "^16.9.0 || ^17.0.0",
"react-dom": "^16.9.0 || ^17.0.0",
"react-final-form": "^6.3.3",
Expand Down
10 changes: 9 additions & 1 deletion packages/ra-core/src/form/FormWithRedirect.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,11 @@ import {
FormRenderProps as FinalFormFormRenderProps,
} from 'react-final-form';
import arrayMutators from 'final-form-arrays';
import { submitErrorsMutators } from 'final-form-submit-errors';

import useInitializeFormWithRecord from './useInitializeFormWithRecord';
import useWarnWhenUnsavedChanges from './useWarnWhenUnsavedChanges';
import useResetSubmitErrors from './useResetSubmitErrors';
import sanitizeEmptyValues from './sanitizeEmptyValues';
import getFormInitialValues from './getFormInitialValues';
import { FormContextValue, Record, OnSuccess, OnFailure } from '../types';
Expand Down Expand Up @@ -51,7 +53,7 @@ const FormWithRedirect: FC<FormWithRedirectProps> = ({
initialValues,
initialValuesEqual,
keepDirtyOnReinitialize = true,
mutators = arrayMutators as any, // FIXME see https://github.com/final-form/react-final-form/issues/704 and https://github.com/microsoft/TypeScript/issues/35771
mutators = defaultMutators,
record,
render,
save,
Expand Down Expand Up @@ -208,6 +210,11 @@ export interface FormWithRedirectOwnProps {
warnWhenUnsavedChanges?: boolean;
}

const defaultMutators = {
...arrayMutators,
...submitErrorsMutators,
};

const defaultSubscription = {
submitting: true,
pristine: true,
Expand Down Expand Up @@ -236,6 +243,7 @@ const FormView: FC<FormViewProps> = ({
// if record changes (after a getOne success or a refresh), the form must be updated
useInitializeFormWithRecord(props.record);
useWarnWhenUnsavedChanges(warnWhenUnsavedChanges);
useResetSubmitErrors();
const dispatch = useDispatch();

useEffect(() => {
Expand Down
2 changes: 2 additions & 0 deletions packages/ra-core/src/form/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ import useChoices, {
} from './useChoices';
import useSuggestions from './useSuggestions';
import useWarnWhenUnsavedChanges from './useWarnWhenUnsavedChanges';
import useResetSubmitErrors from './useResetSubmitErrors';

export type {
ChoicesProps,
Expand Down Expand Up @@ -52,6 +53,7 @@ export {
useSuggestions,
ValidationError,
useWarnWhenUnsavedChanges,
useResetSubmitErrors,
};
export { isRequired } from './FormField';
export * from './validate';
Expand Down
27 changes: 27 additions & 0 deletions packages/ra-core/src/form/useResetSubmitErrors.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
import { useEffect, useRef } from 'react';
import { useForm } from 'react-final-form';

/**
* Reset the submission error when the corresponding field changes.
* final-form doesn't do this by default.
*/
const useResetSubmitErrors = () => {
const form = useForm();
const prevValues = useRef(form.getState().values);
useEffect(() => {
const unsubscribe = form.subscribe(
({ values }) => {
form.mutators.resetSubmitErrors({
current: values,
prev: prevValues.current,
});

prevValues.current = values;
},
{ values: true }
);
return unsubscribe;
}, [form]);
};

export default useResetSubmitErrors;
1 change: 1 addition & 0 deletions packages/react-admin/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@
"connected-react-router": "^6.5.2",
"final-form": "^4.20.0",
"final-form-arrays": "^3.0.1",
"final-form-submit-errors": "^0.1.2",
"ra-core": "~3.13.1",
"ra-i18n-polyglot": "~3.13.1",
"ra-language-english": "~3.13.1",
Expand Down
5 changes: 5 additions & 0 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -8217,6 +8217,11 @@ final-form-arrays@^3.0.1:
resolved "https://registry.yarnpkg.com/final-form-arrays/-/final-form-arrays-3.0.2.tgz#9f3bef778dec61432357744eb6f3abef7e7f3847"
integrity sha512-TfO8aZNz3RrsZCDx8GHMQcyztDNpGxSSi9w4wpSNKlmv2PfFWVVM8P7Yj5tj4n0OWax+x5YwTLhT5BnqSlCi+w==

final-form-submit-errors@^0.1.2:
version "0.1.2"
resolved "https://registry.yarnpkg.com/final-form-submit-errors/-/final-form-submit-errors-0.1.2.tgz#1c59d10386d7b5a1a5e89f9389fa7cf85d1255c5"
integrity sha512-2EwHSdf9Sy80bnsGRrDKBLp5C2uY7hL65o8tpqK/FWxyBpXtT519SsIZC4etLpGen2kjFCpYrxYkzFUfbIEXsQ==

final-form@^4.20.0:
version "4.20.0"
resolved "https://registry.yarnpkg.com/final-form/-/final-form-4.20.0.tgz#454ba46f783a4c4404ad875cf36f470395ad5efa"
Expand Down