npm 包 cra-form-builder 使用教程

阅读时长 6 分钟读完

介绍

cra-form-builder 是一款基于 React 和 Ant Design 的表单构建工具。该工具可以让你快速构建符合 Ant Design 风格的表单,并且支持表单校验以及自定义表单项。cra-form-builder 采用了通用的表单数据结构,使得表单数据的处理更加便捷。

安装

使用 npm 安装:

或者使用 yarn 安装:

使用

引入组件

渲染表单

属性说明

  • formItems: 表单项的配置数组,具体格式如下:
-- -------------------- ---- -------
-
  -
    ------ -----
    ----- -------
    ----- -------
    ------------ --------
    --------- ----
  --
  -
    ------ -----
    ----- ---------
    ----- --------
    -------- -
      -
        ------ ----
        ------ ------
      --
      -
        ------ ----
        ------ --------
      -
    --
    --------- ----
  --
  -- ---
-
  • formRules: 表单项的校验规则,具体格式可以参考 Ant Design 的校验规则,例如:
  • onSubmit: 提交表单的回调函数,可以在该函数中对表单数据进行处理。例如:
  • initialValues: 表单项的初始值,具体格式与 formItems 中一致。

自定义表单项

我们可以通过 customItems 属性来自定义表单项。

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

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

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

示例代码

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

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

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

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

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

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

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

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

总结

使用 cra-form-builder 可以轻松、快速地构建符合 Ant Design 风格的表单,并且支持表单校验和自定义表单项。希望本文对大家有所帮助。

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

纠错
反馈