docs_vue2/one/docs/components/form.md

Form 表单

:::tip Form 组件需要配合 Fieldset 及 Field 组件使用。 :::

示例

基础样式

使用 actions 插槽来提供表单操作按钮。

只读状态

设置 readonly 来使内部表单项处于只读状态。

禁用状态

设置 disabled 来使内部表单项处于禁用状态。

校验

API

属性

名称	类型	默认值	描述
readonly	boolean=	false	内部输入组件是否为只读状态。
disabled	boolean=	false	内部输入组件是否为禁用状态。
data	Object	-	[^data]
validators	Array<Object>=	-	[^validators]
before-validate	function=	-	表单进入提交流程后，进行校验之前的 hook，传入参数为 (data)，data 为表单 data 属性值的副本。支持返回 Promise，返回值或 Promise.resolve 的值为 true 或 undefined 表示流程继续，其它返回值表示中断流程并触发 invalid 事件。
after-validate	function=	-	表单校验成功后，触发 submit 事件之前的 hook，传入参数为 (data)，与 beforeValidate 的入参是同一个引用。支持返回 Promise，返回值或 Promise.resolve 的值为 true 或 undefined 表示流程继续，其它返回值表示中断流程并触发 invalid 事件。

^^^data 表单绑定的数据，和表单中的输入组件通过 v-model 绑定，也是表单校验时的数据源。

:::warning Field 如果处于 disabled 状态，提交流程中处理 data 副本时其对应的数据键值对会被过滤，校验时同理。 ::: ^^^

^^^validators 表单联合校验、异步校验器。项目类型为 {fields, validate, triggers}。

+++属性详情

名称	类型	描述
fields	Array	对应 Field 的 field 描述的集合。事件会绑定到对应 Field 中的输入组件上。
validate	function	自定义校验函数，传入参数为 (data[fields[0]], data[fields[1]], ...)，data 为表单 data 属性值的引用。返回 undefined/true 代表校验成功，返回 {[field]: message, ...} 表示校验失败信息，详见表单 › 表单校验逻辑。
triggers	`string	Array`
+++

+++规则详情

fields	triggers	绑定事件情况
['a']	['change', 'blur,input,xxx', 'submit']	a(change)
['a','b','c']	['change', 'blur,input,xxx', 'submit']	a(change), b(blur,input,xxx), c(submit)
['a','b','c']	'blur'	a(blur), b(submit), c(submit)
['a','b','c']	'blur,input'	a(blur,input), b(blur,input), c(blur,input)
+++
^^^

插槽

名称	描述
default	可直接内联 Fieldset 或 Field 组件。无默认内容。
actions	表单操作内容，如“提交”、“取消”按钮等。无默认内容。

事件

名称	描述
submit	[^event-submit]
invalid	[^event-invalid]

^^^event-submit 在原生 submit 事件之后触发，回调参数为 (data, event)。具体提交流程请参考表单 › 表单提交流程。

+++参数详情

名称	类型	描述
data	Object	表单 data 属性值的引用。
event	Event	原生事件对象。
+++
^^^

^^^event-invalid beforeValidate、validate、afterValidate 流程中某一项返回中断时触发，回调参数为流程 function 的返回值，参数为 (result)，表示流程中断的信息，具体返回值类型由流程返回决定。具体提交流程请参考表单 › 表单提交流程，validate 逻辑见表单 › 表单校验逻辑。 ^^^

表单提交流程

graph TD
A[Native submit event] --> B[Clone data object]
B --> C["beforeValidate(data)"]
C -- not set / resolved --> D["validate()"]
D --> E{isValid?}
E -- Y --> F["afterValidate(data)"]
F -- not set / reslved --> G["$emit('submit', data, event')"]
C -- rejected --> H["$emit('invalid', result)"]
D -- N --> H
F -- rejected --> H

:::warning beforeValidate 和 afterValidate 以及 sumbit 事件操作的 data 均为 props data 的同一个副本。考虑到校验信息和 UI 中数据的一致性，validate 的目标数据是 props data 的源数据。因此在 beforeValidate 中不建议修改 data 副本。 :::

表单校验逻辑

表单校验内部分为 Field 的 rule 校验和 validators 的校验。

1. Field 的 rule 是单值、同步校验。详见表单项。
2. validators 可以是多值、异步的校验。

+++validators 示例

validators: [
  {
    fields: ['start', 'end'],
    validate (start, end) {
      if (start == null || end == null) {
        return true
      }

      if (parseInt(start, 10) >= parseInt(end, 10)) {
        return {
          start: '下限必须小于上限'
        }
      }
      return true
    },
    triggers: ['change', 'submit,input']
  },
  {
    fields: ['phone'],
    validate (phone) {
      return new Promise(function (resolve) {
        setTimeout(function () {
          let res
          if (phone === '18888888888') {
            res = {
              phone: '该手机已被注册'
            }
          }
          return resolve(res)
        }, 3000)
      })
    },
    triggers: ['input']
  }
]

+++

Field 的 rule 和 validators 的优先级

校验失败的信息会添加到对应的 Field 的 validities 信息中。由于同个操作触发的校验，validators 的校验结果优先级大于 Field 的 rule，不同操作触发的校验，展现最后一个结果。Field 的 rule 内部的优先级，参考表单项 › 属性。

交互过程的校验

graph LR
A[Interaction events] -->B[Field#validate]
A --> C[validators.validate]
B --> D{isValid?}
C --> D
D -- Y --> E[Hide validities]
D -- N --> F[Show errors]

提交过程的校验

graph LR
A[validate] -->B[Field#validate]
A --> C[validators.validate]
B --> D[Merge validities]
C --> D
D --> E{isValid?}
E -- Y --> F["Promise.resolve(true)"]
E -- N --> G["Promise.resolve(error)"]

提交时，其中一个过程的校验失败不会导致整个校验终止，校验信息将在两个过程执行完毕后进行整合，并传递到 invalid 事件中去。