npm 包 @trioxis/immutable-react-form 使用教程

阅读时长 6 分钟读完

简介

@trioxis/immutable-react-form (以下简称 immutable-react-form) 是一个基于 React 的表单库,可以帮助前端开发者快速创建可靠、可扩展、易维护的表单。它封装了常见的表单组件和表单校验逻辑,使得前端开发者可以专注于业务逻辑的实现。

安装

安装 immutable-react-form 其实非常简单,只需使用以下命令即可:

或者使用 yarn:

使用

使用 immutable-react-form,我们需要首先创建一个表单数据模型。比如,下面是一个简单的示例:

这个数据模型中包含了两个属性:usernamepassword

接下来,我们需要创建一个表单组件:

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

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

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

在上面的代码中,我们使用了 Form 组件来包裹表单,指定了数据模型 LOGIN_FORM_MODEL 和提交回调函数 onSubmit。然后,我们在表单中使用 Text 组件来创建文本输入框。

最后,我们需要将 LoginForm 组件挂载到页面中:

这样,一个基本的表单组件就完成了。在实际项目中,我们还可以通过传递配置参数,添加更多的表单验证逻辑,来实现更丰富的表单功能。

配置参数

可以针对不同的组件进行灵活的参数配置,这样可以更加方便的定制表单功能。下面是常用的配置参数:

  • validate:定义表单的验证逻辑,可以是一个函数或一个数组。如果是一个函数,会接收表单数据对象作为参数,返回一个对象,包含验证结果。如果是一个数组,数组的每个元素都是一个函数,依次执行验证逻辑,返回一个包含所有验证结果的对象。示例代码:

    -- -------------------- ---- -------
    -------- ---------------- -
      ----- ------ - ---
    
      -- ------------------ -
        --------------- - -----------
      -
    
      -- ------------------ -
        --------------- - -----------
      - ---- -- ----------------------- - -- -
        --------------- - --------- ---- -- -- ----- - ---------- ------
      -
    
      ------ -------
    -
    
    -- ---
    
    ----- ------------------------ ------------------- --------------------
      -- ---
    -------
  • asyncValidate:定义表单的异步验证逻辑,可以是一个函数或一个数组,与 validate 相似。异步验证逻辑会在 validate 验证通过之后执行,使用异步验证可以避免表单数据的重复提交。示例代码:

    -- -------------------- ---- -------
    -------- --------------------- -
      ------ --- ----------------- ------- -- -
        ------------- -- -
          -- ---------------- --- -------- -
            -------- --------- --------- ------- ------ ---
          - ---- -
            ----------
          -
        -- ------
      ---
    -
    
    -- ---
    
    -----
      ------------------------
      -------------------
      -------------------
      -----------------------------
    -
      -- ---
    -------
  • onSubmitFail:当表单验证失败时被调用,传递一个错误对象作为参数。示例代码:

    -- -------------------- ---- -------
    -------- -------------------- -
      --------------------
    -
    
    -- ---
    
    -----
      ------------------------
      -------------------
      -------------------
      ---------------------------
    -
      -- ---
    -------
  • onChange:当某个表单字段的值改变时被调用,传递一个对象 { field, value }

总结

immutable-react-form 是一个帮助前端开发者创建可靠、可扩展、易维护的表单的 React 库。使用它,我们可以快速地创建表单,同时添加灵活的配置参数,来满足不同的需求。希望本文能对大家学习和使用 immutable-react-form 产生帮助和指导作用。

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

纠错
反馈