amis2/index.md at 236f97952304aa9678c99ad8d06b8cace45e0dbb

test/amis2

mirror of https://gitee.com/baidu/amis.git synced 2024-12-02 12:08:13 +08:00

docs: 将 cfc 的 mock 接口放到项目中支持文档离线访问；将大部分图片外联都放入项目中管理 (#2366 )

2021-08-09 18:05:01 +08:00

46 KiB

Executable File

Raw Blame History

title	description	type	group	menuName	icon	order
Form 表单		0	⚙ 组件	Form 表单		24

表单是 amis 中核心组件之一，主要作用是提交或者展示表单数据。

基本用法

最基本的用法是配置表单项和提交接口api。

如下我们配置姓名和邮箱表单项，并可以填写数据并提交给接口/api/mock2/form/saveForm。

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名："
      },
      {
        "name": "email",
        "type": "input-email",
        "label": "邮箱："
      }
    ]
}

表单展示

默认模式

默认展示模式为文字表单项分行显示

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名："
      },
      {
        "name": "email",
        "type": "input-email",
        "label": "邮箱："
      }
    ]
}

水平模式

水平模式，左右摆放，左右比率分配。

{
    "type": "form",
    "title": "水平模式",
    "mode": "horizontal",
    "body": [
      {
        "type": "input-email",
        "name": "email",
        "label": "邮箱",
        "required": true
      },
      {
        "type": "input-password",
        "name": "password",
        "label": "密码"
      },
      {
        "type": "checkbox",
        "name": "rememberMe",
        "label": "记住登录"
      }
    ]
}

可以配置horizontal属性，调整偏移量，格式如下：

"horizontal": {
    "left": 2,
    "right": 10,
    "offset": 2
}

{
    "type": "form",
    "title": "水平模式",
    "mode": "horizontal",
    "horizontal": {
      "left": 2,
      "right": 10,
      "offset": 2
    },
    "body": [
      {
        "type": "input-email",
        "name": "email",
        "label": "邮箱",
        "required": true
      },
      {
        "type": "input-password",
        "name": "password",
        "label": "密码"
      },
      {
        "type": "checkbox",
        "name": "rememberMe",
        "label": "记住登录"
      }
    ]
}

通过上面的配置可以看出来水平布局其实按比率分配的。实际上有时候固定左侧宽度更好看点。

"horizontal": {
    "leftFixed": true
}

也可以直接配置 'xs' | 'sm' | 'md' | 'lg' 来定义左侧 label 的宽度。

{
    "type": "form",
    "title": "水平模式",
    "mode": "horizontal",
    "horizontal": {
      "leftFixed": "sm"
    },
    "body": [
      {
        "type": "input-email",
        "name": "email",
        "label": "邮箱",
        "required": true
      },
      {
        "type": "input-password",
        "name": "password",
        "label": "密码"
      },
      {
        "type": "checkbox",
        "name": "rememberMe",
        "label": "记住登录"
      }
    ]
}

内联模式

使用内联模式展现表单项

 {
    "type": "form",
    "title": "内联模式",
    "mode": "inline",
    "body": [
      {
        "type": "input-email",
        "name": "email",
        "label": "邮箱"
      },
      {
        "type": "input-password",
        "name": "password"
      },
      {
        "type": "checkbox",
        "name": "rememberMe",
        "label": "记住登录"
      },
      {
        "type": "submit",
        "label": "登录"
      }
    ]
  }

实现一行展示多个表单项

使用 group 实现一行显示多个表单项

 [
    {
      "type": "form",
      "title": "常规模式",
      "body": [
        {
          "type": "group",
          "body": [
            {
              "type": "input-email",
              "name": "email",
              "label": "邮箱"
            },
            {
              "type": "input-password",
              "name": "password",
              "label": "密码"
            }
          ]
        }
      ]
    },
    {
      "type": "form",
      "title": "水平模式",
      "mode": "horizontal",
      "body": [
        {
          "type": "group",
          "body": [
            {
              "type": "input-email",
              "name": "email2",
              "label": "邮箱"
            },
            {
              "type": "input-password",
              "name": "password2",
              "label": "密码"
            }
          ]
        }
      ]
    },
    {
      "type": "form",
      "title": "内联模式",
      "mode": "inline",
      "body": [
        {
          "type": "group",
          "body": [
            {
              "type": "input-email",
              "name": "email",
              "label": "邮箱"
            },
            {
              "type": "input-password",
              "name": "password",
              "label": "密码"
            }
          ]
        }
      ]
    }
  ]

底部按钮栏

隐藏默认提交按钮

Form 默认会在底部渲染一个提交按钮，用于执行表单的提交行为。你可以通过两种方式去掉这个默认的提交按钮：

配置："submitText": ""
配置："actions": []

[
    {
      "type": "form",
      "title": "通过 submitText 去掉提交按钮",
      "submitText": "",
      "body": [
        {
          "type": "input-text",
          "name": "email",
          "label": "邮箱"
        }
      ]
    },
    {
      "type": "form",
      "title": "通过 actions 去掉提交按钮",
      "actions": [],
      "body": [
        {
          "type": "input-text",
          "name": "email",
          "label": "邮箱"
        }
      ]
    }
  ]

配置若干自定义按钮

同样，你可以通过 actions 属性，配置任意你想要的行为按钮。

{
    "type": "form",
    "title": "表单",
    "body": [
      {
        "type": "input-text",
        "name": "email",
        "label": "邮箱"
      },
      {
        "type": "input-password",
        "name": "password",
        "label": "密码"
      }
    ],
    "actions": [
      {
        "type": "submit",
        "label": "登录"
      },
      {
        "type": "action",
        "actionType": "dialog",
        "label": "登录须知",
        "dialog": {
          "title": "登录须知",
          "body": "登录须知"
        }
      },
      {
        "type": "button",
        "label": "百度一下",
        "url": "https://www.baidu.com/"
      }
    ]
  }

请记住，如果想触发表单提交行为，请配置"actionType": "submit"或"type": "submit"按钮

去掉表单边框

通过配置"wrapWithPanel": false，可以去掉默认表单边框（包括标题，按钮栏以及边距样式等）。

{
    "type": "form",
    "wrapWithPanel": false,
    "body": [
      {
        "type": "input-text",
        "name": "email",
        "label": "邮箱"
      },
      {
        "type": "input-password",
        "name": "password",
        "label": "密码"
      }
    ]
  }

注意！配置该属性后，title和actions属性将失效并无法渲染，请在表单内自行配置。

固定底部栏

如果表单项较多导致表单过长，而不方便操作底部的按钮栏，可以配置"affixFooter": true属性，将底部按钮栏固定在浏览器底部

表单项数据初始化

表单可以通过配置initApi，实现表单初始化时请求接口，用于展示数据或初始化表单项。

{
    "type": "form",
    "initApi": "/api/mock2/form/initData",
    "title": "编辑用户信息",
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名"
      },
      {
        "type": "input-text",
        "name": "email",
        "label": "邮箱"
      }
    ]
}

比如以上这个例子接口返回为

{
    status: 0,
    msg: "",
    data: {
        name: "Amis Renderer",
        author: "fex",
        date: 1615978757,
        info: ""
    }
}

第一个表单项的 name 配置为 name，所以这个表单初始化完毕后展示 Amis Renderer。

表单项的 value 是不支持表达式，所以不要尝试用 value: "${xxx}" 来关联数据。

轮询初始化请求

Form 支持轮询初始化接口，步骤如下：

配置initApi
配置 interval：单位为毫秒，最小 1000

{
    "type": "form",
    "initApi": "/api/mock2/page/initData",
    "interval": 3000,
    "title": "表单",
    "body": [
      {
        "type": "input-text",
        "name": "date",
        "label": "时间戳"
      }
    ]
  }

如果希望在满足某个条件的情况下停止轮询，配置stopAutoRefreshWhen表达式。

{
    "type": "form",
    "initApi": "/api/mock2/page/initData",
    "interval": 3000,
    "title": "表单",
    "stopAutoRefreshWhen": "this.date % 5",
    "body": [
      {
        "type": "input-text",
        "name": "date",
        "label": "时间戳"
      }
    ]
  }

静态初始化数据域

我们也可以手动设置 form 的数据域来初始化多个表单项值

{
    "type": "form",
    "data": {
      "name": "rick",
      "email": "rick@gmail.com"
    },
    "title": "用户信息",
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名"
      },
      {
        "type": "input-email",
        "name": "email",
        "label": "邮箱"
      }
    ]
  }

数据格式一致性问题

当表单来初始化表单项值时，需要保持数据格式的一致性。

如果表单初始化的值与表单项配置的数据格式不符合，而且用户没有再次操作该表单项，而直接提交表单，那么会将当前默认值原封不动的提交给后端，也许会导致不一致性的问题，我们看一个例子：

{
    "type": "form",
    "data": {
        "select": ["a", "c"]
    },
    "body": [
        {
            "label": "选项",
            "type": "select",
            "name": "select",
            "multiple": true,
            "options": [
                {
                    "label":"A",
                    "value":"a"
                },
                {
                    "label":"B",
                    "value":"b"
                },
                {
                    "label":"C",
                    "value":"c"
                }
            ]
        }
    ]
}

上例中， select 我们配置了"multiple": true，预期中，我们希望选中 A 和 C 项时，表单项的数据格式为："a,c"，但是我们表单数据域中，select默认值为"value": ["a", "c"]，并不符合我们当前表单项的数据格式配置，这样会导致两个问题：

有可能不会默认选中 A 和 C 选项；
当不操作该表单项，直接提交时，预期是："a,c"，但提交给后端的数据为：["a", "c"]，导致了不一致性的问题。

通过 initApi 配置默认值同理，不再赘述

因此一定确保默认值与选择器表单项数据格式配置相匹配。

表单提交

配置api属性，当表单执行提交行为时，会默认将当前表单数据域中的数据使用post方式发送给所配置api

{
    "type": "form",
    "api": "/api/saveForm",
    "title": "用户信息",
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名"
      },
      {
        "type": "input-email",
        "name": "email",
        "label": "邮箱"
      }
    ]
  }

点击提交按钮，会看到发送表单请求，请求数据体为：

{
  "name": "xxx",
  "email": "xxx@xx.com"
}

发送请求默认为 POST 方式，会将所有表单项整理成一个对象发送过过去。除此之外你可以主动获取以下信息。

diff 只会包含 diff 结果
prinstine 原始数据如:

{
  "api": {
    "method": "post",
    "url": "/api/xxx/save",
    "data": {
      "modified": "$$",
      "diff": "${diff}",
      "origin": "${prinstine}"
    }
  }
}

如果返回了 data 对象，且是对象，会把结果 merge 到表单数据里面。

当你需要配置特定的请求方式，请求体，header时，使用对象类型 api 配置，并使用数据映射进行数据配置。

下面示例我们更改了请求方法为PUT，并在原提交数据的基础上添加一个字段"_from"。更多用法查看 API 文档和数据映射文档

{
    "type": "form",
    "initApi": {
      "method": "put",
      "url": "/api/mock2/page/initData",
      "data": {
        "&": "$$$$",
        "_from": "browser"
      }
    },
    "title": "用户信息",
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名"
      },
      {
        "type": "input-email",
        "name": "email",
        "label": "邮箱"
      }
    ]
  }

触发表单提交行为有下面几种方式：

默认的提交按钮
为行为按钮配置"actionType": "submit"
配置"type": "submit"的按钮

轮询提交请求

通过设置asyncApi，当表单提交发送保存接口后，还会继续轮询请求该接口，默认间隔为3秒，直到返回 finished 属性为 true 才结束。

{
    "type": "form",
    "initApi": "/api/mock2/page/initData",
    "asyncApi": "/api/mock2/page/initData",
    "title": "用户信息",
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名"
      },
      {
        "type": "input-email",
        "name": "email",
        "label": "邮箱"
      }
    ]
  }

如果决定结束轮询的标识字段名不是 finished，请设置finishedField属性，比如："finishedField": "is_success"

表单校验

一般可以通过在表单项格式校验中，配置校验规则完成校验，但是有时候，我们需要组合多个表单项实现一些校验，这时可以通过配置 rules 来实现组合校验。

例如下例，我们想校验 a 和 b 表单项不可以同时有值，否则就报错，则可以进行如下配置：

{
  "type": "form",
  "api": "/api/form/saveForm",
  "rules": [
    {
      "rule": "!(data.a && data.b)",
      "message": "a 和 b 不能同时有值"
    }
  ],
  "body": [
    {
      "type": "input-text",
      "name": "a",
      "label": "A"
    },
    {
      "type": "input-text",
      "name": "b",
      "label": "B"
    }
  ]
}

rule 编写使用表达式

重置表单

配置"type": "reset"或者"actionType": "reset"的按钮，可以实现点击重置表单项值。

{
    "type": "form",
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名"
      },
      {
        "type": "input-email",
        "name": "email",
        "label": "邮箱"
      }
    ],
    "actions": [
        {
            "type": "reset",
            "label": "重置"
        },
        {
            "type": "submit",
            "label": "保存"
        }
    ]
  }

请注意：这里的重置是将表单数据域重置到初始状态，而不是清空，如果你配置了初始化接口，那么重置操作是会将表单项重置至初始化表单项值

表单数据域调试

配置debug:true可以查看当前表单的数据域数据详情，方便数据映射、表达式等功能调试，如下，你可以修改表单项查看数据域变化

{
    "type": "form",
    "title": "用户信息",
    "debug": true,
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名"
      },
      {
        "type": "input-email",
        "name": "email",
        "label": "邮箱"
      }
    ]
  }

该配置不会展示完整的数据链，只会展示当前表单的数据域

禁用数据链

默认表单是可以获取到完整数据链中的数据的，但是该默认行为不适用于所有场景，例如：

在 CRUD 的列表项中配置弹框，弹框中有一个表单，则该表单项中所有的同name表单项都会根据上层crud的行数据进行初始化，如果你是实现编辑的功能那并没有是什么问题，但是如果你是新建功能，那么这将不符合你的预期，你可以手动设置"canAccessSuperData": false来关闭该行为

提交后行为

表单提交成功后，可以执行一些行为。

重置表单

如果想提交表单成功后，重置当前表单至初始状态，可以配置"resetAfterSubmit": true。

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "resetAfterSubmit": true,
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名："
      },
      {
        "name": "email",
        "type": "input-email",
        "label": "邮箱："
      }
    ]
  }

编辑表单项，点击提交，成功后会发现表单项的值会重置到初始状态，即空

注意，如果表单项有默认值，则会将该表单项的值重置至该默认值。

跳转页面

配置redirect属性，可以指定表单提交成功后要跳转至的页面

{
    "type": "form",
    "initApi": "/api/mock2/page/initData",
    "redirect": "/user/list",
    "title": "用户信息",
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名"
      },
      {
        "type": "input-email",
        "name": "email",
        "label": "邮箱"
      }
    ]
  }

刷新目标组件

配置reload属性为其他组件name值，可以在表单提交成功之后，刷新指定组件。

[
    {
      "type": "form",
      "initApi": "/api/mock2/page/initData",
      "title": "用户信息",
      "reload": "my_service",
      "body": [
        {
          "type": "input-text",
          "name": "name",
          "label": "姓名"
        },
        {
          "type": "input-email",
          "name": "email",
          "label": "邮箱"
        }
      ]
    },
    {
      "type": "service",
      "name": "my_service",
      "api": "/api/mock2/page/initData",
      "body": "service初识数据"
    }
  ]

上例中form提交成功后，会触发name为my_service的Service组件重新请求初始化接口

上面示例是一种组件间联动

将数据域发送给目标组件

配置target属性为目标组件name值，可以在触发提交行为后，将当前表单的数据域发送给目标组件。

[
    {
      "type": "form",
      "target": "detailForm",
      "body": [
        {
          "type": "input-text",
          "placeholder": "关键字",
          "name": "keywords"
        }
      ]
    },
    {
      "type": "form",
      "name": "detailForm",
      "initApi": "/api/mock2/page/initData?keywords=${keywords}",
      "body": [
        {
          "label": "名称",
          "type": "static",
          "name": "name"
        },
        {
          "label": "作者",
          "type": "static",
          "name": "author"
        },
        {
          "label": "关键字",
          "type": "static",
          "name": "keywords"
        },
        {
          "label": "请求时间",
          "type": "static-datetime",
          "format": "YYYY-MM-DD HH:mm:ss",
          "name": "date"
        }
      ]
    }
  ]

第一个表单在提交时，会将它的表单数据域数据发送给detailForm表单，触发detailForm的初始化接口联动，重新请求接口更新数据域，并更新关键字表单项。

上面示例组合使用了组件间联动和接口联动

持久化保存表单项数据

表单默认在重置之后（切换页面、弹框中表单关闭表单），会自动清空掉表单中的所有数据，如果你想持久化保留当前表单项的数据而不清空它，那么通过 Form 配置 persistData: "xxx"，指定一个 key ，来实现数据持久化保存

注意，如果使用在 CRUD 列表中的编辑框内的 Form 中，可以利用数据映射语法，persistData: "xxx:${id}"，来为 form 指定一个唯一的 key

如果想提交成功后，清空该缓存，则配置"clearPersistDataAfterSubmit": true

禁用回车提交

表单默认情况下回车就会提交，如果想阻止这个行为，可以加上 preventEnterSubmit 配置项。

{
    "type": "form",
    "api": "/api/mock2/form/saveForm",
    "preventEnterSubmit": true,
    "body": [
      {
        "type": "input-text",
        "name": "name",
        "label": "姓名："
      },
      {
        "name": "email",
        "type": "input-email",
        "label": "邮箱："
      }
    ]
}

属性表

属性名	类型	默认值	说明
type	`string`		`"form"` 指定为 Form 渲染器
name	`string`		设置一个名字后，方便其他组件与其通信
mode	`string`	`normal`	表单展示方式，可以是：`normal`、`horizontal` 或者 `inline`
horizontal	`Object`	`{"left":"col-sm-2", "right":"col-sm-10", "offset":"col-sm-offset-2"}`	当 mode 为 `horizontal` 时有用，用来控制 label
title	`string`	`"表单"`	Form 的标题
submitText	`String`	`"提交"`	默认的提交按钮名称，如果设置成空，则可以把默认按钮去掉。
className	`string`		外层 Dom 的类名
body	Array<表单项 or SchemaNode >		Form 表单项集合
actions	Array<行为按钮>		Form 提交按钮，成员为 Action
messages	`Object`		消息提示覆写，默认消息读取的是 API 返回的消息，但是在此可以覆写它。
messages.fetchSuccess	`string`		获取成功时提示
messages.fetchFailed	`string`		获取失败时提示
messages.saveSuccess	`string`		保存成功时提示
messages.saveFailed	`string`		保存失败时提示
wrapWithPanel	`boolean`	`true`	是否让 Form 用 panel 包起来，设置为 false 后，actions 将无效。
panelClassName	`string`		外层 panel 的类名
api	API		Form 用来保存数据的 api。
initApi	API		Form 用来获取初始数据的 api。
rules	Array<{rule:string;message:string}>		表单组合校验规则
interval	`number`	`3000`	刷新时间(最低 3000)
silentPolling	`boolean`	`false`	配置刷新时是否显示加载动画
stopAutoRefreshWhen	`string`	`""`	通过表达式来配置停止刷新的条件
initAsyncApi	API		Form 用来获取初始数据的 api,与 initApi 不同的是，会一直轮询请求该接口，直到返回 finished 属性为 true 才结束。
initFetch	`boolean`	`true`	设置了 initApi 或者 initAsyncApi 后，默认会开始就发请求，设置为 false 后就不会起始就请求接口
initFetchOn	`string`		用表达式来配置
initFinishedField	`string`	`finished`	设置了 initAsyncApi 后，默认会从返回数据的 data.finished 来判断是否完成，也可以设置成其他的 xxx，就会从 data.xxx 中获取
initCheckInterval	`number`	`3000`	设置了 initAsyncApi 以后，默认拉取的时间间隔
asyncApi	API		设置此属性后，表单提交发送保存接口后，还会继续轮询请求该接口，直到返回 `finished` 属性为 `true` 才结束。
checkInterval	`number`	3000	轮询请求的时间间隔，默认为 3 秒。设置 `asyncApi` 才有效
finishedField	`string`	`"finished"`	如果决定结束的字段名不是 `finished` 请设置此属性，比如 `is_success`
submitOnChange	`boolean`	`false`	表单修改即提交
submitOnInit	`boolean`	`false`	初始就提交一次
resetAfterSubmit	`boolean`	`false`	提交后是否重置表单
primaryField	`string`	`"id"`	设置主键 id, 当设置后，检测表单是否完成时（asyncApi），只会携带此数据。
target	`string`		默认表单提交自己会通过发送 api 保存数据，但是也可以设定另外一个 form 的 name 值，或者另外一个 `CRUD` 模型的 name 值。如果 target 目标是一个 `Form` ，则目标 `Form` 会重新触发 `initApi`，api 可以拿到当前 form 数据。如果目标是一个 `CRUD` 模型，则目标模型会重新触发搜索，参数为当前 Form 数据。当目标是 `window` 时，会把当前表单的数据附带到页面地址上。
redirect	`string`		设置此属性后，Form 保存成功后，自动跳转到指定页面。支持相对地址，和绝对地址（相对于组内的）。
reload	`string`		操作完后刷新目标对象。请填写目标组件设置的 name 值，如果填写为 `window` 则让当前页面整体刷新。
autoFocus	`boolean`	`false`	是否自动聚焦。
canAccessSuperData	`boolean`	`true`	指定是否可以自动获取上层的数据并映射到表单项上
persistData	`string`	`""`	指定一个唯一的 key，来配置当前表单是否开启本地缓存
clearPersistDataAfterSubmit	`boolean`	`true`	指定表单提交成功后是否清除本地缓存
preventEnterSubmit	`boolean`	`false`	禁用回车提交表单
trimValues	`boolean`	`false`	trim 当前表单项的每一个值
promptPageLeave	`boolean`	`false`	form 还没保存，即将离开页面前是否弹框确认。

46 KiB Executable File Raw Blame History Unescape Escape

基本用法

表单展示

默认模式

水平模式

内联模式

实现一行展示多个表单项

底部按钮栏

隐藏默认提交按钮

配置若干自定义按钮

去掉表单边框

固定底部栏

表单项数据初始化

轮询初始化请求

静态初始化数据域

数据格式一致性问题

表单提交

轮询提交请求

表单校验

重置表单

表单数据域调试

禁用数据链

提交后行为

重置表单

跳转页面

刷新目标组件

将数据域发送给目标组件

持久化保存表单项数据

禁用回车提交

属性表

46 KiB

Executable File

Raw Blame History