npm包yup使用教程

阅读时长 6 分钟读完

在前端开发过程中,表单校验是必不可少的。yup是一个用于JavaScript对象的验证器和模式库,它提供了一种简单但强大的方式来验证表单数据并保持数据的正确性。本文将以实际代码为例,介绍如何使用yup进行表单校验。

安装yup

首先,我们需要安装yup依赖包,使用如下命令进行安装:

简单使用

以下是最简单的使用yup的方式。我们通过yup.string来检测一个字符串是否是合法的。如果不合法,yup会以错误信息返回给我们。

-- -------------------- ---- -------
------ - -- --- ---- ------

----- ------ - ------------------------

-------------------------------------------- -
  ------ -- ----
---

--------------------------------------- -
  ------ -- -----
---
展开代码

高级使用

yup可以同时验证多个值,包括字符串、数字、对象、数组等。以下是一个复杂一些的示例:

-- -------------------- ---- -------
------ - -- --- ---- ------

----- ------ - --------------------
  ----- -------------------------------
  ---- ---------------------------------------------
  ------ ---------------------
  -------- -------------------
  ---------- ----------------------------- -
    ------ --- -------
  ---
---

----- --------- - -
  ----- -------
  ---- ---
  ------ -------------------
  -------- ----------------------
--

---------------------------------------------- -
  ------ -- ----
---

----- ----------- - -
  ----- ----
  ---- ---- - --------
  ------ ---- -- -------
  -------- ---- - -----
--

------------------------------------------------ -
  --------- -- -----------------
  ----------- -- ------ ---- -- -- ----- - ------------
  ------------------ -- -----
  -------------------- -- ----- ---- -- - -------- ---- ---- -- - -------- --------
  -- ---
---
展开代码

在这个示例中,我们定义了一个对象,并在其中定义了多个规则。当我们的测试数据通过验证时,我们得到了true。如果数据不符合规则,我们可以通过catch来捕获 ValidationError。我们还可以检索到特定的错误对象。

使用yup处理表单错误

在React中,我们可以使用yup来处理表单的验证错误。以下是一个示例:

-- -------------------- ---- -------
------ - -- --- ---- ------

----- ------ - --------------------
  ----- -------------------------------
  ------ --------------------------------
---

----- ---- ------- --------------- -
  ------------------ -
    -------------

    ---------- - -
      ----- ---
      ------ ---
      ------- ---
    --

    ---------------------- - ----------------------------------
    ----------------- - -----------------------------
  -

  ------------------------ -
    ----- ------ - -------------
    ----- ----- - ----------- --- ---------- - -------------- - -------------
    ----- ---- - ------------

    ---------------
      ------- ------
    ---
  -

  ------------------- -
    -----------------------

    --------------------------- - ----------- ----- ---------- -- -
      ----------------------
    -------------- -- -
      --- ------ - ---

      --------------------- -- -
        -------------- - ----------
      ---

      ---------------
        ------- -------
      ---
    ---
  -

  -------- -
    ------ -
      ----- -----------------------------
        -----
          --------------------
          ------ ----------- ----------- --------------------------------- --
          -----------------------------------
        ------
        -----
          ---------------------
          ------ ------------ ------------ --------------------------------- --
          ------------------------------------
        ------
        
        ------- -----------------------------
      -------
    --
  -
-
展开代码

这个示例中,我们创建了一个表单组件,在组件的state中加入了errors对象,用于存储表单验证错误。我们定义了一个handleSubmit方法,在表单提交时首先进行表单验证。如果存在错误,我们将错误信息存储在state中,并在表单输入框下方展示错误信息。

总结

yup是一个简单而又强大的表单校验库,它支持字符串、数字、对象、数组等各种验证类型。它的API也非常简单易用。yup可以用于React中,来处理表单验证错误。 在实际开发中,我们应该建议使用yup来实现表单校验,来保证表单数据的准确性和一致性。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/109123