0.5.3 • Published 3 years ago

simple-element v0.5.3

Weekly downloads
323
License
-
Repository
github
Last release
3 years ago

介绍

对 element 常用组件的封装,易于上手。

安装

npm:

\$ npm install simple-element

yarn:

\$ yarn add simple-element

快速使用

// main.js
import ElementUI from 'element-ui'
import 'element-ui/lib/theme-chalk/index.css'
import SimpleElement from 'simple-element'

// 引入Element组件,可按需引入 https://element.eleme.cn/#/zh-CN/component/quickstart#an-xu-yin-ru
Vue.use(ElementUI)
// 引入SimpleElement组件
Vue.use(SimpleElement)

通用组件

com-dialog

通用弹窗组件,内部实现滚动和关闭自动回滚到顶部的功能。用于作为组件根布局。

属性类型默认值描述
visibleboolfalse是否可见
titlestring''标题
loadingboolfalse是否显示标题栏的 loading
close-on-click-modalboolfalse点击 modal 是否关闭弹窗
widthstring''弹窗宽度
max-heightstring'70vh'弹窗内容区域最大高度
before-closefunctionnull点击关闭按钮的回调函数
其他属性----自动绑定在内部 el-dialog 组件上

com-form

通用表单组件,封装了表单元素的自动生成、校验、确认按钮和取消按钮。

属性类型默认值描述
formobject{}表单数据
inlinebooleanfalse表单元素和标题是否显示在同一行
renderAllbooleanfalse是否全部表单元素通过插槽插入,不使用自动生成组件功能
rulesobject{}表单校验规则,非空时才有效,与 renderAll 搭配使用
labelPositionstring'left'表单元素标题位置,可选值:top/left/right
labelWidthstring'100px'表单元素标题宽度
loadingbooleanfalse是否显示加载状态。加载时,表单区域会显示半透明,不可输入和点击
rowLennumber2每一行容纳的表单元素数量
submitBtnLabelstring'确认'确认按钮文字
cancelBtnLabelstring'取消'取消按钮文字
showBottomBtnbooleantrue显示底部确认和取消按钮
showSubmitBtnbooleantrue显示底部确认按钮
showCancelBtnbooleantrue显示底部取消按钮
rowListarray[]可根据该属性自动生成表单元素,详情如下

rowList 属性为二维数组,元素可为以下选项

  1. 对象,用于单独实现一行表单数组。值为{ render: true, type: xxx, ...},即必须包含 render 属性且值为 true。
  2. 数组,对应的字段如下表。
键值类型描述
hiddenboolean是否隐藏
typestring表单元素类型,可选值:input/textarea/date-picker/radio-group/com-select
labelstring表单元素标题内容
propstring标识表单元素在 form 表单中对应的唯一属性
requiredboolean表单元素是否不能为空
newlineboolean设置表单元素换行并且铺满整行,只有在 com-form inline 设置为 false 时有效
requireTypestring校验的数值类型,可选值:string/array
widthstring表单元素宽度,支持百分比和带单位数值,不指定则为整行宽度除以 rowLen
disabledboolean是否设置为不可输入状态
renderboolean是否以插槽实现自定义渲染
rulesarray校验规则
placeholderstring自定义 placeholder,为空时会自动生成
compPropobject表单元素的相关属性,会直接透传给组件
optionsarray用于如 radio-group 等的选项列表,不同类型会有不同的字段,详情如下
hideLabelboolean是否隐藏标题,默认为 false
labelWidthboolean标题宽度,不设置时取 com-form 的 labelWidth
radio-group 类型元素 options
键值类型描述
valuestring/value选项的值
labelstring选项的标题

回调事件

事件描述参数
submit点击确认按钮-
cancel点击取消按钮-

插槽

  • default。renderAll 为 true 时对应的插槽。
  • render-row。rowList 对象元素对应的插槽 。

    slot-scope 属性类型描述
    typestring对象的 type 属性
    formDataarray表单数据
  • render-item。rowList 数组元素某一项自定义内容对应的插槽 。

    slot-scope 属性类型描述
    formDataarray表单数据
    itemobject该项数据完整内容
    propstring数据的 prop 属性
    indexRownumber数据对应的列索引
    indexItemnumber数据对应的行索引
  • bottom-btn。自定义底部确认和取消按钮的插槽,非空时会替换默认的按钮。

com-form-item

表单元素的包装层,封装了 tooltip。

属性类型默认值描述
showToolTipboolfalse是否包装 tooltip
toolTipLabelstring''tooltip 内容
labelstring''表单元素标题
propstring''表单唯一标识
requiredbooleanfalse是否必需
newlinebooleanfalse设置表单元素换行并且铺满整行,只有在 com-form inline 设置为 false 时有效
labelWidthstring'100px'表单元素标题宽度
labelPositionstring'left'表单元素标题位置,可选值为 left/right/top

com-table

表格组件元素的包装层,封装顶部搜索栏、侧弹选项栏和底部分页栏。

搜索栏相关的属性

属性类型默认值描述
controlSizestringmedium按钮、输入控件的大小
showSearchBarbooleantrue是否显示顶部的搜索栏
showSearchBlockbooleantrue是否显示顶部的搜索区域(搜索类型,关键字和搜索按钮)
searchFieldsarray[]可搜索的字段,为字符串数组
searchParamsobject{key:'',word:''}搜索参数
showMoreBtnbooleanfalse是否显示更新选项按钮,点击显示侧弹 drawer
moreBlockPropobject{}透传给侧弹 drawer 的属性
showHidebooleanfalse是否显示隐藏筛选区域
showAddbooleanfalse是否显示新增按钮
autoResetbooleantrue重置之后是否回调 getList 事件

表格相关的属性

属性类型默认值描述
tableDataarray[]表格数据
tableColumnarray[]表格列字段
filterParamsobject{}表格过滤参数
sortParamsobject{}表格排序参数
tableFormatterfunctionnull表格格式化函数,参考https://element.eleme.cn/#/zh-CN/component/table
tableFiltersfunctionnull表格获取过滤参数的函数,参考https://element.eleme.cn/#/zh-CN/component/table
selectedarray[]表格已选择行
draggablebooleanfalse表格行是否可拖动
tableRowKeystring''table 组件的 row-key 属性,对应于表格记录的唯一标识,draggable 设置为 true 之后是必需的
tableProparray[]table 组件其他属性

分页栏相关的属性

属性类型默认值描述
showPaginationbooleanfalse是否显示分页栏
paginationobject{}分页参数
showMutilDelbooleanfalse是否显示批量删除按键

回调事件

事件参数描述
getList请求列表事件,在点击搜索按钮、修改过滤、排序、分页和重置之后会回调该事件
onAdd在点击新增按钮之后会回调该事件
onReset在点击重置按钮之后会回调该事件
onMutilDel在点击批量删除按钮重置之后会回调该事件
onMoreSubmit在点击侧弹的确认按钮重置之后会回调该事件

插槽

  • search-front。搜索栏前置区域的插槽。
  • search-before-search。搜索按钮前区域的插槽。
  • search-middle。搜索栏中间区域的插槽。
  • more-options。侧弹栏的插槽。
  • table-custom。表格自定义列的插槽。

    slot-scope 属性类型描述
    rowarray表单行数据
    columnobject表单列信息
    colKeystring表格列对应的 field
    valnumber表格列 field 对应的值
    indexnumber表格行索引
  • bottom。表格底部搜索栏中间插槽。

0.5.4

3 years ago

0.5.3

3 years ago

0.5.2

3 years ago

0.4.9

3 years ago

0.5.0

3 years ago

0.5.1

3 years ago

0.4.8

3 years ago

0.4.7

3 years ago

0.4.6

4 years ago

0.4.5

4 years ago

0.4.4

4 years ago

0.4.3

4 years ago

0.4.2

4 years ago

0.4.1

4 years ago

0.4.0

4 years ago

0.3.1

4 years ago

0.3.0

4 years ago

0.2.8

4 years ago

0.2.7

4 years ago

0.2.6

4 years ago

0.2.5

4 years ago

0.2.4

4 years ago

0.2.3

4 years ago

0.2.2

4 years ago

0.2.1

4 years ago

0.1.11

4 years ago

0.2.0

4 years ago

0.1.10

4 years ago

0.1.9

4 years ago

0.1.8

4 years ago

0.1.7

4 years ago

0.1.6

4 years ago

0.1.5

4 years ago

0.1.4

4 years ago

0.1.3

4 years ago

0.1.2

4 years ago

0.1.1

4 years ago