将 history.block 与异步函数/回调/异步/等待一起使用

时间:2021-03-08 12:14:33

标签: reactjs async-await react-router react-router-dom formik

我在路由中有一个表单,如果有任何验证错误,它不应该允许用户导航到另一条路由。如果没有验证错误,则允许导航到另一条路线。

以下是我当前的代码,onBlock 函数不起作用对其异步性质,因为提交然后验证表单的函数是异步的。

FormComponent.js

import React, { useState, useEffect, useRef } from "react";
import { FieldArray } from "formik";
import { useHistory } from "react-router-dom";
import * as Yup from "yup";
import Form from "./Form";
import TextInput from "./TextInput";

const FormComponent = () => {
  const history = useHistory();
  const [initialValues, setInitialValues] = useState();
  const [isSubmitted, setIsSubmitted] = useState(false);
  const block = useRef();

  const formRef = useRef(null);

  const onFormSubmit = async (values) => {
    setIsSubmitted(true);
  };

  const validationSchema = () => {
    const schema = {
      test: Yup.string().required("Input is Required")
    };
    return Yup.object(schema);
  };

  const onBlock = () => {
    const { submitForm, validateForm } = formRef?.current || {};
    // submit form first
    submitForm()
      .then(() => {
        // then validate form
        validateForm()
          .then(() => {
            // if form is valid - should navigate to route
            // if form is not valid - should remain on current route
            return formRef?.current.isValid;
          })
          .catch(() => false);
      })
      .catch(() => false);
  };

  const redirectToPage = () => {
    history.push("/other-page");
  };

  useEffect(() => {
    block.current = history.block(onBlock);

    return () => {
      block.current && block.current();
    };
  });

  useEffect(() => {
    if (isSubmitted) redirectToPage();
  }, [isSubmitted]);

  useEffect(() => {
    setInitialValues({
      test: ""
    });
  }, []);

  return initialValues ? (
    <Form
      initialValues={initialValues}
      onSubmit={onFormSubmit}
      formRef={formRef}
      validationSchema={validationSchema}
    >
      <FieldArray
        name="formDetails"
        render={(arrayHelpers) =>
          arrayHelpers && arrayHelpers.form && arrayHelpers.form.values
            ? (() => {
                const { form } = arrayHelpers;
                formRef.current = form;
                return (
                  <>
                    <TextInput name="test" />
                    <button type="submit">Submit</button>
                  </>
                );
              })()
            : null
        }
      />
    </Form>
  ) : null;
};

export default FormComponent;

如果用户尝试在输入中没有任何值的情况下提交表单,我希望 onBlock 会返回 false 以阻止导航。但这似乎不起作用。但是,只需在 false 函数中返回 onBlock 即可。所以看起来 history.block 函数不接受任何回调。我还尝试将其转换为 async 函数和 await submitFormvalidateForm 函数,但仍然没有乐趣。有没有解决的办法?任何帮助将不胜感激。

这是 CodeSandbox 的例子。

1 个答案:

答案 0 :(得分:2)

history.block 函数接受提示回调,您可以使用它来提示用户或执行其他操作以响应页面被阻止。要阻止该页面,您只需调用 history.block() more info here

formik 表单在您尝试提交时进行验证,如果验证成功,则继续提交表单,此时将调用 onSubmit 回调。因此,如果您想在出现验证错误时阻止页面,您可以使用 formik 上下文来订阅验证 isValid 以及每当这是错误阻止时。

const useIsValidBlockedPage = () => {
  const history = useHistory();
  const { isValid } = useFormikContext();

  useEffect(() => {
    const unblock = history.block(({ pathname }) => {
      // if is valid we can allow the navigation
      if (isValid) {
        // we can now unblock
        unblock();
        // proceed with the blocked navigation
        history.push(pathname);
      }
      // prevent navigation
      return false;
    });

    // just in case theres an unmount we can unblock if it exists
    return unblock;
  }, [isValid, history]);
};

这是改编自您的codesandbox。我删除了一些不需要的组件。

另一种解决方案是手动验证所有页面转换并选择何时允许自己转换,在这种情况下,如果 validateForm 没有返回错误。

// blocks page transitions if the form is not valid
const useFormBlockedPage = () => {
  const history = useHistory();
  const { validateForm } = useFormikContext();

  useEffect(() => {
    const unblock = history.block(({ pathname }) => {
     // check if the form is valid
      validateForm().then((errors) => {
        // if there are no errors this form is valid
        if (Object.keys(errors).length === 0) {
          // Unblock the navigation.
          unblock();
          // retry the pagination
          history.push(pathname);
        }
      });
      // prevent navigation
      return false;
    });
    return unblock;
  }, [history, validateForm]);
};

还有 codesandbox 在这里