Skip to content

submit 提交组件

单独页面使用

常用于设置页面,如网站基础设置,需设置 isPage 为 true, formConfig.popupType 设置page,隐藏取消按钮

提交类型及各类型配置

该组件提交类型分为3种,edit编辑,add保存,save提交。 单独使用时,需设置type值 add/edit, 使用集成组件时无需设置, save 需要开启保存按钮。
关于类型配置本示例只展示编辑,其他2个类型更编辑相同,只是减少了一些配置

表单验证配置

表单验证配置分为3个地方, formAttrs 下的, add/edit 下的formItems 子项的 formItemPropAttrs 下的, 如果相同后面的覆盖前面的,不同就合并。

展示类型

该组件展示类型分为三种,可以通过配置 popupType实现,分别为 drawer(抽屉), dialog(弹窗),page(独立页面)

底部按钮配置

通过footerConfig配置按钮的显示隐藏,按钮的文字。通过formBottonformBotton-after插槽自定义底部按钮。

tabs

可以通过配置 tabs, 该属性和 formItems二者互斥只能选其一

其他

当 popuptype 为 drawer 或 dialog 时, 可以通过设置 width 改变弹窗的大小,该组件打开时会出发 openCb 回调。





以下2个示例也适用于 search 组件,在search组件不在说明

element组件的属性和方法设置

该组件包含三部分 element 组件,el-form, el-form-item, 表单组件: el-input等, 配置位置按顺序一次在,formAttrs, formItemPropAttrs, propAttrs

响应式布局

采用栅格化布局,一行分为 24份,预设了五个响应尺寸:xs、sm、md、lg 和 xl。可以通过formConfig 下的 layoutformItems 子项下的 layout, 前者为全部子项,后者为单独,后者覆盖前者。

API

属性说明Type默认值
formConfig表单配置,详见formConfig配置object-
isPagepopupType 为 page时,单独使用该组件时使用,表单永久显示booleanfalse
type类型,值:add(新增) / edit(编辑) ,单独使用该组件时使用string-

formConfig 配置

属性说明Type默认值
popupType窗口类型,drawer(抽屉)/dialog(弹窗)/page(独立页面)stringdrawer
width弹窗大小 popupType为 drawer或dialog时有效stringdrawer时 600 / dialog 时 800
openCb弹窗打开时的回调函数,接收参数:xbFormRef(该组件实例)function-
popupAttrs窗口样式,详见el-drawer/el-dialogobject{
   alignCenter: true
}
formAttrs表单样式, 详见el-form
此处的 rules 为公用校验
function{
   labelWidth: "100px"
   rule: {}
}
save保存功能配置,详见add配置object-
add添加功能配置,详见add配置object-
edit添加功能配置,详见edit配置object-
tabs切换功能, formItems/tabs 二者选一, 详见tabs配置array-
formItems表单子项配置,详见xb-formarray-
footerConfig底部按钮配置,详见footerConfig配置object-
layout栅格占据的列数,
xs: <768px
sm: ≥768px
md: ≥992px
lg: ≥1200px
xl: ≥1920px
object{
  span: 24,
}

tabs配置

属性说明Type默认值
label选项卡标题string---
formItems表单子项配置,详见xb-formarray-

save配置

属性说明Type默认值
requestApi添加接口promise-
paramsFormat格式化请求参数function-
responseFormat格式化请求返回的数据function-

add配置

属性说明Type默认值
title添加弹窗标题, 支持函数string/function添加
requestApi添加接口promise-
rules表单验证规则,合并 formAttrs 中 rules 配置object-
paramsFormat格式化请求参数function-
responseFormat格式化请求返回的数据function-

edit配置

属性说明Type默认值
title编辑弹窗标题,支持函数string/function修改
requestApi编辑接口promise-
rules表单验证规则,合并 formAttrs 中 rules 配置object-
idKey编辑 id 的 key 值stringid
idValueKey编辑 id 值的 key 值stringid
paramsFormat格式化请求参数function-
responseFormat格式化请求返回的数据function-

footerConfig底部按钮配置

属性说明类型默认值
saveBtnShow保存按钮是否显示, 为函数时接受2个参数,type(类型) / formRef(表单组件实例),需 return false 或 trueboolean/functionfalse
saveBtnTitle保存按钮文字string保存
cancelBtnShow取消按钮是否显示, 为函数时 同 saveBtnShowboolean/functiontrue
cancelBtnTitle取消按钮文字string取消
submitBtnShow提交按钮是否显示, 为函数时 同 saveBtnShowboolean/functiontrue
submitBtnTitle提交按钮文字string提交

Slots 插槽

插槽名说明
headContent表单页面顶部内容插槽
formBotton底部按钮区域插槽, 值:
xbFormRef (该组件实例)
changePopupStatus (表单组件状态切换函数集,changePopupStatus.open() 打开表单,changePopupStatus.close() 关闭表单)
changeSubmitStatus()
formBotton-after同上 |