Skip to content

表单配置

本文将介绍如何设置表单配置中的UI相关配置,并详细说明各个配置项的作用。

表单全局配置

设置表单配置

以下是设置表单配置的方法:

  • 组件模式

在模板中设置表单配置:

html
<form-create :option="option"></form-create>
  • 全局方法

你还可以通过全局方法创建表单并设置表单配置:

js
window.formCreate.create(rule, option)

构成

全局配置中额外支持一下配置项

  • form:表单整体显示规则配置
  • row:表单组件布局配置
  • submitBtn:提交按钮样式配置
  • resetBtn:重置按钮样式配置
  • info:组件提示消息配置
  • wrap: 配置FormItem

配置表单(form)

  • 类型Object

  • 说明:配置表单的整体显示规则,比如标签对齐方式和输入框对齐方式。

  • 默认值:

js
  {
    //行内表单模式
    inline: false,
    //表单域标签的位置,如果值为 left 或者 right 时,则需要设置 label-width
    labelPosition: 'right',
    //表单域标签的后缀
    labelSuffix: undefined,
    //是否显示必填字段的标签旁边的红色星号
    hideRequiredAsterisk: false,
    //表单域标签的宽度,例如 '50px'。作为 Form 直接子元素的 form-item 会继承该值。支持 auto。
    labelWidth: '125px',
    //是否显示校验错误信息
    showMessage: true,
    //是否以行内形式展示校验信息
    inlineMessage: false,
    //是否在输入框中显示校验结果反馈图标
    statusIcon: false,
    //是否在 rules 属性改变后立即触发一次验证
    validateOnRuleChange: true,
    //是否禁用该表单内的所有组件。若设置为 true,则表单内组件上的 disabled 属性不再生效
    disabled: false,
    //用于控制该表单内组件的尺寸 medium / small / mini
    size: undefined,
    //是否显示 label
    title: true
  }

配置布局(row)

  • 类型Object

  • 说明:配置表单组件的布局,比如组件之间的间距。

  • 默认值:

js
  {
    //栅格间隔
    gutter: 0,
    //布局模式,可选 flex,现代浏览器下有效
    type: undefined,
    //flex 布局下的垂直排列方式 top/middle/bottom
    align: undefined,
    //flex 布局下的水平排列方式 start/end/center/space-around/space-between
    justify: undefined,
    //自定义元素标签
    tag: 'div'
  }

配置提交按钮(submitBtn)

  • 类型Object

  • 说明:配置提交按钮的样式和布局。

  • 默认值:

js
  {
    //类型 primary / success / warning / danger / info / text
    type: "primary",
    //尺寸 medium / small / mini
    size: "medium",
    //是否朴素按钮
    plain: false,
    //是否圆角按钮
    round: false,
    //是否圆形按钮
    circle: false,
    //是否加载中状态
    loading: false,
    //是否禁用状态
    disabled: false,
    //图标类名
    icon: 'el-icon-upload',
    //按钮宽度
    width: '100%',
    //是否默认聚焦
    autofocus: false,
    //原生 type 属性
    nativeType: "button",
    //按钮内容
    innerText: "提交",
    //按钮是否显示
    show: true,
    //按钮布局规则
    col: undefined,
    //按钮点击事件
    click: undefined,
  }

如果不需要显示提交按钮,可以将 submitBtn 设置为 falsesubmitBtn.show 设置为 false

配置重置按钮(resetBtn)

  • 类型Object

  • 说明:配置重置按钮的样式和布局。

  • 默认值:

js
  {
    type: "default",
    size: "medium",
    plain: false,
    round: false,
    circle: false,
    loading: false,
    disabled: false,
    icon: 'el-icon-refresh',
    width: '100%',
    autofocus: false,
    nativeType: "button",
    innerText: "重置",
    show: false,
    col: undefined,
    click: undefined,
  }

如果需要显示重置按钮,可以将 resetBtn 设置为 trueresetBtn.show 设置为 true

悬浮提示框(info)

  • 类型Object

  • 说明:组件提示消息配置

  • 默认值:

js
  {
    //提示消息类型,popover,tooltip
    type:"popover",
    align: "left"
  }

可以在info配置项中设置提示组件的属性

配置 FormItem(wrap)

  • 类型Object

  • 说明:配置 FormItem 组件的显示规则,例如字段的样式和布局。

  • 参考: FormItem_props

FormCreate 是一个开源项目,基于 MIT 许可证发布,欢迎个人和企业用户免费使用