MineAdmin 交流群

官方QQ群: 150105478

Skip to content

MaForm

基于 Element plus 的表单二次封装的 Form 组件,支持所有原生表单的参数、事件、插槽、写法,还支持通过配置方式来实现。 另外还支持了基于 el-rowel-space 的布局来规划表单

说明

由于全部兼容及支持原生 el-from 的所有参数、事件、插槽,所以只讲扩展参数。

官方表单参数请参考 Element plus 官方文档。

配置方式使用

模板方式使用

获取组件el-form-itemRef

提示

这个方式用于 配置形式template 里可以自己定义 ref

Props

参数说明类型Ele-官网文档版本
v-modelma-form数据,双向绑定MaModel-1.0.0
optionsel-form 参数及扩展参数MaFormOptions表单属性1.0.0
itemsma-form-item参数MaFormItem[]-1.0.0

ExtraProps

说明

此为 ma-formel-form 的扩展参数

参数说明类型默认值版本
containerClass表单容器类名string-1.0.0
loading是否开启加载动画booleanfalse1.0.0
loadingConfig加载动画的相关配置LoadingConfig-1.0.0
layout鼠标放上查看flex, gridflex1.0.0
grid鼠标放上查看el-space文档-1.0.0
flex鼠标放上查看el-row文档-1.0.0
footerSlot鼠标放上查看() => {}-1.0.0

LoadingConfig说明

参数说明类型默认值版本
text显示在加载图标下方的加载文案string-1.0.0
spinner自定义加载图标string-1.0.0
svg自定义 svg 加载图标string-1.0.0
viewBox加载图标的大小string-1.0.0
background背景遮罩的颜色string-1.0.0
customClass自定义 class 类名string-1.0.0

MaFormItem

参数说明类型默认值版本
label增强原生参数,添加支持函数类型string, () => string-1.0.0
prop增强原生参数,添加支持函数类型string, () => string-1.0.0
hide鼠标放上查看鼠标放上查看false1.0.0
show鼠标放上查看鼠标放上查看true1.0.0
colsoptions.layout 为 flex 下生效el-col文档-1.0.0
itemPropsel-form-item 原生属性表单项属性-1.0.0
itemSlotsel-form-item 原生插槽表单项插槽-1.0.0
render渲染组件:鼠标放上查看string, (data) => any-1.0.0
renderProps被渲染组件的 props 属性Record<string, any>-1.0.0
renderSlots被渲染组件的插槽Record<string, (...args) => {}>-1.0.0

Slot

名称说明参数
default默认插槽,可写原生标签 <el-form-item>,配置方式自动失效-
footer表单底部插槽-

Expose

名称说明参数返回值
setLoadingState()设置表单 loading 状态(boolean)-
setOptions()设置 ma-form 配置(MaFormOptions)-
getOptions()获取 ma-form 配置-MaFormOptions
setItems()设置表单项(MaFormItem[])-
getItems()获取表单项-MaFormItem[]
appendItem()追加表单项(MaFormItem)-
removeItem()移除表单项(prop: string)-
getItemByProp()prop获取表单项(prop: string)MaFormItem
isMobileState()检查是否为移动端模式-boolean
getElFormRef()获取 el-form Ref-El-Form

致力于为品牌和企业创造价值