@alifd/next/lib/form/api-schema.json

A configurable component library for web built on React.

{
  "name": "Form",
  "props": {
    "prefix": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "样式前缀",
      "defaultValue": {
        "value": "'next-'",
        "computed": false
      },
      "docblock": "样式前缀"
    },
    "inline": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "内联表单",
      "docblock": "内联表单"
    },
    "size": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'large'",
            "computed": false,
            "description": "大"
          },
          {
            "value": "'medium'",
            "computed": false,
            "description": "中"
          },
          {
            "value": "'small'",
            "computed": false,
            "description": "小"
          }
        ]
      },
      "required": false,
      "description": "单个 Item 的 size 自定义，优先级高于 Form 的 size, 并且当组件与 Item 一起使用时，组件自身设置 size 属性无效。",
      "defaultValue": {
        "value": "'medium'",
        "computed": false
      },
      "docblock": "单个 Item 的 size 自定义，优先级高于 Form 的 size, 并且当组件与 Item 一起使用时，组件自身设置 size 属性无效。\n@enumdesc 大, 中, 小",
      "value": [
        {
          "value": "'large'",
          "computed": false,
          "description": "大"
        },
        {
          "value": "'medium'",
          "computed": false,
          "description": "中"
        },
        {
          "value": "'small'",
          "computed": false,
          "description": "小"
        }
      ]
    },
    "fullWidth": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "单个 Item 中表单类组件宽度是否是100%",
      "docblock": "单个 Item 中表单类组件宽度是否是100%"
    },
    "labelAlign": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'top'",
            "computed": false,
            "description": "上"
          },
          {
            "value": "'left'",
            "computed": false,
            "description": "左"
          },
          {
            "value": "'inset'",
            "computed": false,
            "description": "内"
          }
        ]
      },
      "required": false,
      "description": "标签的位置, 如果不设置 labelCol 和 wrapperCol 那么默认是标签在上",
      "defaultValue": {
        "value": "'left'",
        "computed": false
      },
      "docblock": "标签的位置, 如果不设置 labelCol 和 wrapperCol 那么默认是标签在上\n@enumdesc 上, 左, 内",
      "value": [
        {
          "value": "'top'",
          "computed": false,
          "description": "上"
        },
        {
          "value": "'left'",
          "computed": false,
          "description": "左"
        },
        {
          "value": "'inset'",
          "computed": false,
          "description": "内"
        }
      ]
    },
    "labelTextAlign": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'left'",
            "computed": false,
            "description": "左"
          },
          {
            "value": "'right'",
            "computed": false,
            "description": "右"
          }
        ]
      },
      "required": false,
      "description": "标签的左右对齐方式",
      "docblock": "标签的左右对齐方式\n@enumdesc 左, 右",
      "value": [
        {
          "value": "'left'",
          "computed": false,
          "description": "左"
        },
        {
          "value": "'right'",
          "computed": false,
          "description": "右"
        }
      ]
    },
    "field": {
      "type": {
        "name": "any"
      },
      "required": false,
      "description": "field 实例, 传 false 会禁用 field",
      "docblock": "field 实例, 传 false 会禁用 field"
    },
    "saveField": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "保存 Form 自动生成的 field 对象",
      "defaultValue": {
        "value": "func.noop",
        "computed": true
      },
      "docblock": "保存 Form 自动生成的 field 对象",
      "params": [],
      "returns": null
    },
    "labelCol": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "控制第一级 Item 的 labelCol",
      "docblock": "控制第一级 Item 的 labelCol",
      "properties": []
    },
    "wrapperCol": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "控制第一级 Item 的 wrapperCol",
      "docblock": "控制第一级 Item 的 wrapperCol",
      "properties": []
    },
    "onSubmit": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "form内有 `htmlType=\"submit\"` 的元素的时候会触发",
      "defaultValue": {
        "value": "function preventDefault(e) {\n    e.preventDefault();\n}",
        "computed": false
      },
      "docblock": "form内有 `htmlType=\"submit\"` 的元素的时候会触发",
      "params": [],
      "returns": null
    },
    "children": {
      "type": {
        "name": "any"
      },
      "required": false,
      "description": "子元素",
      "docblock": "子元素"
    },
    "className": {
      "type": {
        "name": "string"
      },
      "required": false,
      "description": "扩展class",
      "docblock": "扩展class"
    },
    "style": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "自定义内联样式",
      "docblock": "自定义内联样式",
      "properties": []
    },
    "value": {
      "type": {
        "name": "object"
      },
      "required": false,
      "description": "表单数值",
      "docblock": "表单数值",
      "properties": []
    },
    "onChange": {
      "type": {
        "name": "func"
      },
      "required": false,
      "description": "表单变化回调",
      "defaultValue": {
        "value": "func.noop",
        "computed": true
      },
      "docblock": "表单变化回调\n@param {Object} values 表单数据\n@param {Object} item 详细\n@param {String} item.name 变化的组件名\n@param {String} item.value 变化的数据\n@param {Object} item.field field 实例",
      "params": [
        {
          "name": "values",
          "description": "表单数据",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "item",
          "description": "详细",
          "type": {
            "name": "Object"
          }
        },
        {
          "name": "item.name",
          "description": "变化的组件名",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "item.value",
          "description": "变化的数据",
          "type": {
            "name": "String"
          }
        },
        {
          "name": "item.field",
          "description": "field 实例",
          "type": {
            "name": "Object"
          }
        }
      ],
      "returns": null
    },
    "component": {
      "type": {
        "name": "union",
        "value": [
          {
            "name": "string"
          },
          {
            "name": "func"
          }
        ]
      },
      "required": false,
      "description": "设置标签类型",
      "defaultValue": {
        "value": "'form'",
        "computed": false
      },
      "docblock": "设置标签类型"
    },
    "device": {
      "type": {
        "name": "enum",
        "value": [
          {
            "value": "'phone'",
            "computed": false
          },
          {
            "value": "'tablet'",
            "computed": false
          },
          {
            "value": "'desktop'",
            "computed": false
          }
        ]
      },
      "required": false,
      "description": "预设屏幕宽度",
      "defaultValue": {
        "value": "'desktop'",
        "computed": false
      },
      "docblock": "预设屏幕宽度"
    },
    "responsive": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否开启内置的响应式布局 （使用ResponsiveGrid）",
      "docblock": "是否开启内置的响应式布局 （使用ResponsiveGrid）\n@version 1.19",
      "version": {
        "value": "1.19",
        "computed": false
      }
    },
    "isPreview": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否开启预览态",
      "docblock": "是否开启预览态\n@version 1.19",
      "version": {
        "value": "1.19",
        "computed": false
      }
    },
    "useLabelForErrorMessage": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否使用 label 替换校验信息的 name 字段",
      "docblock": "是否使用 label 替换校验信息的 name 字段\n@version 1.20",
      "version": {
        "value": "1.20",
        "computed": false
      }
    },
    "preferMarginToDisplayHelp": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "倾向使用 item 的 margin 空间来展示 help",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "倾向使用 item 的 margin 空间来展示 help\n@default false\n@version 1.26.37",
      "version": {
        "value": "1.26.37",
        "computed": false
      }
    },
    "colon": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "表示是否显示 label 后面的冒号",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "表示是否显示 label 后面的冒号\n@version 1.22",
      "version": {
        "value": "1.22",
        "computed": false
      }
    },
    "disabled": {
      "type": {
        "name": "bool"
      },
      "required": false,
      "description": "是否禁用表单",
      "defaultValue": {
        "value": "false",
        "computed": false
      },
      "docblock": "是否禁用表单"
    }
  },
  "methods": [],
  "subComponents": [
    {
      "name": "Item",
      "props": {
        "prefix": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "样式前缀",
          "defaultValue": {
            "value": "'next-'",
            "computed": false
          },
          "docblock": "样式前缀"
        },
        "label": {
          "type": {
            "name": "node"
          },
          "required": false,
          "description": "label 标签的文本",
          "docblock": "label 标签的文本"
        },
        "labelCol": {
          "type": {
            "name": "object"
          },
          "required": false,
          "description": "label 标签布局，通 `<Col>` 组件，设置 span offset 值，如 {span: 8, offset: 16}，该项仅在垂直表单有效",
          "docblock": "label 标签布局，通 `<Col>` 组件，设置 span offset 值，如 {span: 8, offset: 16}，该项仅在垂直表单有效",
          "properties": []
        },
        "wrapperCol": {
          "type": {
            "name": "object"
          },
          "required": false,
          "description": "需要为输入控件设置布局样式时，使用该属性，用法同 labelCol",
          "docblock": "需要为输入控件设置布局样式时，使用该属性，用法同 labelCol",
          "properties": []
        },
        "help": {
          "type": {
            "name": "node"
          },
          "required": false,
          "description": "自定义提示信息，如不设置，则会根据校验规则自动生成.",
          "docblock": "自定义提示信息，如不设置，则会根据校验规则自动生成."
        },
        "name": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "字段名，默认赋值给第一个子元素",
          "docblock": "字段名，默认赋值给第一个子元素"
        },
        "extra": {
          "type": {
            "name": "node"
          },
          "required": false,
          "description": "额外的提示信息，和 help 类似，当需要错误信息和提示文案同时出现时，可以使用这个。 位于错误信息后面",
          "docblock": "额外的提示信息，和 help 类似，当需要错误信息和提示文案同时出现时，可以使用这个。 位于错误信息后面"
        },
        "validateState": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'error'",
                "computed": false,
                "description": "失败"
              },
              {
                "value": "'success'",
                "computed": false,
                "description": "成功"
              },
              {
                "value": "'loading'",
                "computed": false,
                "description": "校验中"
              },
              {
                "value": "'warning'",
                "computed": false,
                "description": "警告"
              }
            ]
          },
          "required": false,
          "description": "校验状态，如不设置，则会根据校验规则自动生成",
          "docblock": "校验状态，如不设置，则会根据校验规则自动生成\n@enumdesc 失败, 成功, 校验中, 警告",
          "value": [
            {
              "value": "'error'",
              "computed": false,
              "description": "失败"
            },
            {
              "value": "'success'",
              "computed": false,
              "description": "成功"
            },
            {
              "value": "'loading'",
              "computed": false,
              "description": "校验中"
            },
            {
              "value": "'warning'",
              "computed": false,
              "description": "警告"
            }
          ]
        },
        "hasFeedback": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "配合 validateState 属性使用，是否展示 success/loading 的校验状态图标, 目前只有Input支持",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "配合 validateState 属性使用，是否展示 success/loading 的校验状态图标, 目前只有Input支持"
        },
        "style": {
          "type": {
            "name": "object"
          },
          "required": false,
          "description": "自定义内联样式",
          "docblock": "自定义内联样式",
          "properties": []
        },
        "children": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "node"
              },
              {
                "name": "func"
              }
            ]
          },
          "required": false,
          "description": "node 或者 function(values)",
          "docblock": "node 或者 function(values)"
        },
        "size": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'large'",
                "computed": false
              },
              {
                "value": "'small'",
                "computed": false
              },
              {
                "value": "'medium'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "单个 Item 的 size 自定义，优先级高于 Form 的 size, 并且当组件与 Item 一起使用时，组件自身设置 size 属性无效。",
          "docblock": "单个 Item 的 size 自定义，优先级高于 Form 的 size, 并且当组件与 Item 一起使用时，组件自身设置 size 属性无效。"
        },
        "fullWidth": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "单个 Item 中表单类组件宽度是否是100%",
          "docblock": "单个 Item 中表单类组件宽度是否是100%"
        },
        "labelAlign": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'top'",
                "computed": false,
                "description": "上"
              },
              {
                "value": "'left'",
                "computed": false,
                "description": "左"
              },
              {
                "value": "'inset'",
                "computed": false,
                "description": "内"
              }
            ]
          },
          "required": false,
          "description": "标签的位置, 如果不设置 labelCol 和 wrapperCol 那么默认是标签在上",
          "docblock": "标签的位置, 如果不设置 labelCol 和 wrapperCol 那么默认是标签在上\n@enumdesc 上, 左, 内",
          "value": [
            {
              "value": "'top'",
              "computed": false,
              "description": "上"
            },
            {
              "value": "'left'",
              "computed": false,
              "description": "左"
            },
            {
              "value": "'inset'",
              "computed": false,
              "description": "内"
            }
          ]
        },
        "labelTextAlign": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'left'",
                "computed": false,
                "description": "左"
              },
              {
                "value": "'right'",
                "computed": false,
                "description": "右"
              }
            ]
          },
          "required": false,
          "description": "标签的左右对齐方式",
          "docblock": "标签的左右对齐方式\n@enumdesc 左, 右",
          "value": [
            {
              "value": "'left'",
              "computed": false,
              "description": "左"
            },
            {
              "value": "'right'",
              "computed": false,
              "description": "右"
            }
          ]
        },
        "className": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "扩展class",
          "docblock": "扩展class"
        },
        "required": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "[表单校验] 不能为空",
          "docblock": "[表单校验] 不能为空"
        },
        "asterisk": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "required 的星号是否显示",
          "docblock": "required 的星号是否显示"
        },
        "requiredMessage": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "required 自定义错误信息",
          "docblock": "required 自定义错误信息"
        },
        "requiredTrigger": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "array"
              }
            ]
          },
          "required": false,
          "description": "required 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
          "docblock": "required 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
        },
        "min": {
          "type": {
            "name": "number"
          },
          "required": false,
          "description": "[表单校验] 最小值",
          "docblock": "[表单校验] 最小值"
        },
        "max": {
          "type": {
            "name": "number"
          },
          "required": false,
          "description": "[表单校验] 最大值",
          "docblock": "[表单校验] 最大值"
        },
        "minmaxMessage": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "min/max 自定义错误信息",
          "docblock": "min/max 自定义错误信息"
        },
        "minmaxTrigger": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "array"
              }
            ]
          },
          "required": false,
          "description": "min/max 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
          "docblock": "min/max 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
        },
        "minLength": {
          "type": {
            "name": "number"
          },
          "required": false,
          "description": "[表单校验] 字符串最小长度 / 数组最小个数",
          "docblock": "[表单校验] 字符串最小长度 / 数组最小个数"
        },
        "maxLength": {
          "type": {
            "name": "number"
          },
          "required": false,
          "description": "[表单校验] 字符串最大长度 / 数组最大个数",
          "docblock": "[表单校验] 字符串最大长度 / 数组最大个数"
        },
        "minmaxLengthMessage": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "minLength/maxLength 自定义错误信息",
          "docblock": "minLength/maxLength 自定义错误信息"
        },
        "minmaxLengthTrigger": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "array"
              }
            ]
          },
          "required": false,
          "description": "minLength/maxLength 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
          "docblock": "minLength/maxLength 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
        },
        "length": {
          "type": {
            "name": "number"
          },
          "required": false,
          "description": "[表单校验] 字符串精确长度 / 数组精确个数",
          "docblock": "[表单校验] 字符串精确长度 / 数组精确个数"
        },
        "lengthMessage": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "length 自定义错误信息",
          "docblock": "length 自定义错误信息"
        },
        "lengthTrigger": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "array"
              }
            ]
          },
          "required": false,
          "description": "length 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
          "docblock": "length 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
        },
        "pattern": {
          "type": {
            "name": "any"
          },
          "required": false,
          "description": "正则校验",
          "docblock": "正则校验"
        },
        "patternMessage": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "pattern 自定义错误信息",
          "docblock": "pattern 自定义错误信息"
        },
        "patternTrigger": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "array"
              }
            ]
          },
          "required": false,
          "description": "pattern 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
          "docblock": "pattern 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
        },
        "format": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'number'",
                "computed": false
              },
              {
                "value": "'email'",
                "computed": false
              },
              {
                "value": "'url'",
                "computed": false
              },
              {
                "value": "'tel'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "[表单校验] 四种常用的 pattern",
          "docblock": "[表单校验] 四种常用的 pattern"
        },
        "formatMessage": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "format 自定义错误信息",
          "docblock": "format 自定义错误信息"
        },
        "formatTrigger": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "array"
              }
            ]
          },
          "required": false,
          "description": "format 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
          "docblock": "format 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
        },
        "validator": {
          "type": {
            "name": "func"
          },
          "required": false,
          "description": "[表单校验] 自定义校验函数",
          "docblock": "[表单校验] 自定义校验函数",
          "params": [],
          "returns": null
        },
        "validatorTrigger": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "array"
              }
            ]
          },
          "required": false,
          "description": "validator 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/...",
          "docblock": "validator 校验何时触发，默认值 onChange, 原生事件均可使用 onChange/onBlur/onFocus/..."
        },
        "autoValidate": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否修改数据时自动触发校验",
          "docblock": "是否修改数据时自动触发校验"
        },
        "device": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'phone'",
                "computed": false
              },
              {
                "value": "'tablet'",
                "computed": false
              },
              {
                "value": "'desktop'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "预设屏幕宽度",
          "docblock": "预设屏幕宽度"
        },
        "colSpan": {
          "type": {
            "name": "number"
          },
          "required": false,
          "description": "在响应式布局模式下，表单项占多少列",
          "docblock": "在响应式布局模式下，表单项占多少列"
        },
        "labelWidth": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "number"
              }
            ]
          },
          "required": false,
          "description": "在响应式布局下，且label在左边时，label的宽度是多少",
          "defaultValue": {
            "value": "100",
            "computed": false
          },
          "docblock": "在响应式布局下，且label在左边时，label的宽度是多少"
        },
        "isPreview": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否开启预览态",
          "docblock": "是否开启预览态"
        },
        "renderPreview": {
          "type": {
            "name": "func"
          },
          "required": false,
          "description": "预览态模式下渲染的内容",
          "docblock": "预览态模式下渲染的内容\n@param {any} value 根据包裹的组件的 value 类型而决定",
          "params": [
            {
              "name": "value",
              "description": "根据包裹的组件的 value 类型而决定",
              "type": {
                "name": "any"
              }
            }
          ],
          "returns": null
        },
        "errorMessageName": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "替代校验信息的 name 字段，useLabelForErrorMessage 开启的情况下比 label 优先级高",
          "docblock": "替代校验信息的 name 字段，useLabelForErrorMessage 开启的情况下比 label 优先级高"
        },
        "useLabelForErrorMessage": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否使用 label 替换校验信息的 name 字段",
          "docblock": "是否使用 label 替换校验信息的 name 字段"
        },
        "preferMarginToDisplayHelp": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "倾向使用 item 的 margin 空间来展示 help",
          "docblock": "倾向使用 item 的 margin 空间来展示 help\n@default false\n@version 1.26.37",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "version": {
            "value": "1.26.37",
            "computed": false
          }
        },
        "colon": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "表示是否显示 label 后面的冒号",
          "docblock": "表示是否显示 label 后面的冒号"
        },
        "disabled": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否禁用表单",
          "docblock": "是否禁用表单"
        },
        "valueName": {
          "type": {
            "name": "string"
          },
          "required": false,
          "description": "子元素的 value 名称",
          "docblock": "子元素的 value 名称"
        }
      },
      "methods": [
        {
          "name": "getNames",
          "docblock": "从子元素里面提取表单组件. TODO: 2.x 中改为只获取一个元素",
          "modifiers": [],
          "params": [
            {
              "name": "children"
            }
          ],
          "returns": null,
          "description": "从子元素里面提取表单组件. TODO: 2.x 中改为只获取一个元素"
        }
      ],
      "description": "手动传递了 wrapCol labelCol 会使用 Grid 辅助布局; labelAlign='top' 会强制禁用 Grid",
      "order": 1
    },
    {
      "name": "Submit",
      "props": {
        "type": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'primary'",
                "computed": false
              },
              {
                "value": "'secondary'",
                "computed": false
              },
              {
                "value": "'normal'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "按钮的类型",
          "defaultValue": {
            "value": "'normal'",
            "computed": false
          },
          "docblock": "按钮的类型"
        },
        "size": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'small'",
                "computed": false
              },
              {
                "value": "'medium'",
                "computed": false
              },
              {
                "value": "'large'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "按钮的尺寸",
          "defaultValue": {
            "value": "'medium'",
            "computed": false
          },
          "docblock": "按钮的尺寸"
        },
        "icons": {
          "type": {
            "name": "shape",
            "value": {
              "loading": {
                "name": "node",
                "required": false
              }
            }
          },
          "required": false,
          "description": "按钮中可配置的 Icon，格式为 { loading: <Icon type=\"loading\" /> }",
          "defaultValue": {
            "value": "{}",
            "computed": false
          },
          "docblock": "按钮中可配置的 Icon，格式为 { loading: <Icon type=\"loading\" /> }",
          "properties": []
        },
        "iconSize": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "enum",
                "value": [
                  {
                    "value": "'xxs'",
                    "computed": false
                  },
                  {
                    "value": "'xs'",
                    "computed": false
                  },
                  {
                    "value": "'small'",
                    "computed": false
                  },
                  {
                    "value": "'medium'",
                    "computed": false
                  },
                  {
                    "value": "'large'",
                    "computed": false
                  },
                  {
                    "value": "'xl'",
                    "computed": false
                  },
                  {
                    "value": "'xxl'",
                    "computed": false
                  },
                  {
                    "value": "'xxxl'",
                    "computed": false
                  },
                  {
                    "value": "'inherit'",
                    "computed": false
                  }
                ]
              },
              {
                "name": "number"
              }
            ]
          },
          "required": false,
          "description": "按钮中 Icon 的尺寸，用于替代 Icon 的默认大小",
          "docblock": "按钮中 Icon 的尺寸，用于替代 Icon 的默认大小"
        },
        "htmlType": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'submit'",
                "computed": false
              },
              {
                "value": "'reset'",
                "computed": false
              },
              {
                "value": "'button'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "当 component = 'button' 时，设置 button 标签的 type 值",
          "defaultValue": {
            "value": "'button'",
            "computed": false
          },
          "docblock": "当 component = 'button' 时，设置 button 标签的 type 值"
        },
        "component": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'button'",
                "computed": false
              },
              {
                "value": "'a'",
                "computed": false
              },
              {
                "value": "'div'",
                "computed": false
              },
              {
                "value": "'span'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "设置标签类型",
          "defaultValue": {
            "value": "'button'",
            "computed": false
          },
          "docblock": "设置标签类型"
        },
        "loading": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "设置按钮的载入状态",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "设置按钮的载入状态"
        },
        "ghost": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "true",
                "computed": false
              },
              {
                "value": "false",
                "computed": false
              },
              {
                "value": "'light'",
                "computed": false
              },
              {
                "value": "'dark'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "是否为幽灵按钮",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否为幽灵按钮"
        },
        "text": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否为文本按钮",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否为文本按钮"
        },
        "warning": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否为警告按钮",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否为警告按钮"
        },
        "disabled": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否禁用",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否禁用"
        },
        "onClick": {
          "type": {
            "name": "func"
          },
          "required": false,
          "description": "点击提交后触发",
          "defaultValue": {
            "value": "func.noop",
            "computed": true
          },
          "docblock": "点击提交后触发\n@param {Object} value 数据\n@param {Object} errors 错误数据\n@param {class} field 实例",
          "params": [
            {
              "name": "value",
              "description": "数据",
              "type": {
                "name": "Object"
              }
            },
            {
              "name": "errors",
              "description": "错误数据",
              "type": {
                "name": "Object"
              }
            },
            {
              "name": "field",
              "description": "实例",
              "type": {
                "name": "class"
              }
            }
          ],
          "returns": null
        },
        "validate": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "bool"
              },
              {
                "name": "array"
              }
            ]
          },
          "required": false,
          "description": "是否校验/需要校验的 name 数组",
          "docblock": "是否校验/需要校验的 name 数组"
        },
        "field": {
          "type": {
            "name": "object"
          },
          "required": false,
          "description": "自定义 field (在 Form 内不需要设置)",
          "docblock": "自定义 field (在 Form 内不需要设置)",
          "properties": []
        }
      },
      "methods": [],
      "description": "继承 Button API",
      "order": 2
    },
    {
      "name": "Reset",
      "props": {
        "type": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'primary'",
                "computed": false
              },
              {
                "value": "'secondary'",
                "computed": false
              },
              {
                "value": "'normal'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "按钮的类型",
          "defaultValue": {
            "value": "'normal'",
            "computed": false
          },
          "docblock": "按钮的类型"
        },
        "size": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'small'",
                "computed": false
              },
              {
                "value": "'medium'",
                "computed": false
              },
              {
                "value": "'large'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "按钮的尺寸",
          "defaultValue": {
            "value": "'medium'",
            "computed": false
          },
          "docblock": "按钮的尺寸"
        },
        "icons": {
          "type": {
            "name": "shape",
            "value": {
              "loading": {
                "name": "node",
                "required": false
              }
            }
          },
          "required": false,
          "description": "按钮中可配置的 Icon，格式为 { loading: <Icon type=\"loading\" /> }",
          "defaultValue": {
            "value": "{}",
            "computed": false
          },
          "docblock": "按钮中可配置的 Icon，格式为 { loading: <Icon type=\"loading\" /> }",
          "properties": []
        },
        "iconSize": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "enum",
                "value": [
                  {
                    "value": "'xxs'",
                    "computed": false
                  },
                  {
                    "value": "'xs'",
                    "computed": false
                  },
                  {
                    "value": "'small'",
                    "computed": false
                  },
                  {
                    "value": "'medium'",
                    "computed": false
                  },
                  {
                    "value": "'large'",
                    "computed": false
                  },
                  {
                    "value": "'xl'",
                    "computed": false
                  },
                  {
                    "value": "'xxl'",
                    "computed": false
                  },
                  {
                    "value": "'xxxl'",
                    "computed": false
                  },
                  {
                    "value": "'inherit'",
                    "computed": false
                  }
                ]
              },
              {
                "name": "number"
              }
            ]
          },
          "required": false,
          "description": "按钮中 Icon 的尺寸，用于替代 Icon 的默认大小",
          "docblock": "按钮中 Icon 的尺寸，用于替代 Icon 的默认大小"
        },
        "htmlType": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'submit'",
                "computed": false
              },
              {
                "value": "'reset'",
                "computed": false
              },
              {
                "value": "'button'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "当 component = 'button' 时，设置 button 标签的 type 值",
          "defaultValue": {
            "value": "'button'",
            "computed": false
          },
          "docblock": "当 component = 'button' 时，设置 button 标签的 type 值"
        },
        "component": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "'button'",
                "computed": false
              },
              {
                "value": "'a'",
                "computed": false
              },
              {
                "value": "'div'",
                "computed": false
              },
              {
                "value": "'span'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "设置标签类型",
          "defaultValue": {
            "value": "'button'",
            "computed": false
          },
          "docblock": "设置标签类型"
        },
        "loading": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "设置按钮的载入状态",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "设置按钮的载入状态"
        },
        "ghost": {
          "type": {
            "name": "enum",
            "value": [
              {
                "value": "true",
                "computed": false
              },
              {
                "value": "false",
                "computed": false
              },
              {
                "value": "'light'",
                "computed": false
              },
              {
                "value": "'dark'",
                "computed": false
              }
            ]
          },
          "required": false,
          "description": "是否为幽灵按钮",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否为幽灵按钮"
        },
        "text": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否为文本按钮",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否为文本按钮"
        },
        "warning": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否为警告按钮",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否为警告按钮"
        },
        "disabled": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "是否禁用",
          "defaultValue": {
            "value": "false",
            "computed": false
          },
          "docblock": "是否禁用"
        },
        "onClick": {
          "type": {
            "name": "func"
          },
          "required": false,
          "description": "点击提交后触发",
          "defaultValue": {
            "value": "func.noop",
            "computed": true
          },
          "docblock": "点击提交后触发",
          "params": [],
          "returns": null
        },
        "names": {
          "type": {
            "name": "array"
          },
          "required": false,
          "description": "自定义重置的字段",
          "docblock": "自定义重置的字段"
        },
        "toDefault": {
          "type": {
            "name": "bool"
          },
          "required": false,
          "description": "返回默认值",
          "docblock": "返回默认值"
        },
        "field": {
          "type": {
            "name": "object"
          },
          "required": false,
          "description": "自定义 field (在 Form 内不需要设置)",
          "docblock": "自定义 field (在 Form 内不需要设置)",
          "properties": []
        }
      },
      "methods": [],
      "description": "继承 Button API",
      "order": 3
    },
    {
      "name": "Error",
      "props": {
        "name": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "string"
              },
              {
                "name": "array"
              }
            ]
          },
          "required": false,
          "description": "表单名",
          "docblock": "表单名"
        },
        "field": {
          "type": {
            "name": "object"
          },
          "required": false,
          "description": "自定义 field (在 Form 内不需要设置)",
          "docblock": "自定义 field (在 Form 内不需要设置)",
          "properties": []
        },
        "children": {
          "type": {
            "name": "union",
            "value": [
              {
                "name": "node"
              },
              {
                "name": "func"
              }
            ]
          },
          "required": false,
          "description": "自定义错误渲染, 可以是 node 或者 function(errors, state)",
          "docblock": "自定义错误渲染, 可以是 node 或者 function(errors, state)"
        }
      },
      "methods": [],
      "description": "自定义错误展示",
      "order": 4
    }
  ]
}