0.1.2 • Published 2 years ago

jimi-table v0.1.2

Weekly downloads
-
License
-
Repository
-
Last release
2 years ago

j-table

背景

提供一个前端表格业务组件,在新项目需要使用到表格时能快速集成,无需重复封装,节约开发成本,提升开发效率。该组件将根据现有平台中心各个web项目95%表格类型进行具象化。组件实现后,各个web项目需要使用可以自行使用也可自行封装,多样处理,无需严格适配,目的是提升开发效率,怎样更快更高质量完成需求为前提是本组件实现的初衷。

以现有项目框架将采用 vue2+element 项目逐渐使用vue3时 考虑翻译为vue3+elementplus方式

组件具象

组件结构由头、中、尾三部分组成,表格和分页器全部使用透传方式继承Element TablePagination 组件属性和方法

组件头部

即顶部操作栏区域,可配置显示和隐藏,分为左右区域,水平方向支持居左、居右、两端对齐方式,垂直方向支持顶端、底部、居中对齐

头部左边由一个插槽组成 headLeft

头部右边由插槽 headRight 和筛选列头控件组成(可以不开启动态表头功能)

筛选列头(动态表头)

使用默认控件,可配置图标路径、图标大小、图标颜色 将使用 <i></i>元素进行承载

列头配置缓存功能,可控制是否开启缓存

组件中部

即表格区域,布局采用三种方式,第一种完全撑开至父组件提供的高度,第二种存在多少行显示多少行,在达到父组件提供高度时内部表格产生滚动条,第三种传入固定高度,表格固定高度

表格内部数据完全采用接收父组件传入方式

列元素 支持 render自定义列元素

组件尾部

即分页区域,可配置显示和不显示,布局方式与头部一致均可配置,可根据具体情况配置默认配置

具有插槽 pageSlot 在layout属性中设置slot位置即可(可适配国外总条数描述类说明)

框图

框图

参数配置

Attributes

透传 Table 表格

参数说明类型可选值默认值
data显示的数据Array
heightTable 的高度,默认为自动高度。如果 height 为 number 类型,单位 px;如果 height 为 String 类型,则这个高度会设置为 Table 的 style.height 的值,Table 的高度会受控于外部样式String/number
max-heightTable 的最大高度。合法的值为数字或者单位为 px 的高度。String/number
stripe是否为斑马纹 tableBooleanfalse
border是否带有纵向边框Booleanfalse
sizeTable 的尺寸Stringmedium / small / mini
fit列的宽度是否自撑开Booleantrue
show-header是否显示表头Booleantrue
highlight-current-row是否要高亮当前行Booleanfalse
current-row-key当前行的 key,只写属性String,Number
row-class-name行的 className 的回调方法,也可以使用字符串为所有行设置一个固定的 className。Function({row, rowIndex})/String
row-style行的 style 的回调方法,也可以使用一个固定的 Object 为所有行设置一样的 Style。Function({row, rowIndex})/Object
cell-class-name单元格的 className 的回调方法,也可以使用字符串为所有单元格设置一个固定的 className。Function({row, column, rowIndex, columnIndex})/String
cell-style单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有单元格设置一样的 Style。Function({row, column, rowIndex, columnIndex})/Object
header-row-class-name表头行的 className 的回调方法,也可以使用字符串为所有表头行设置一个固定的 className。Function({row, rowIndex})/String
header-row-style表头行的 style 的回调方法,也可以使用一个固定的 Object 为所有表头行设置一样的 Style。Function({row, rowIndex})/Object
header-cell-class-name表头单元格的 className 的回调方法,也可以使用字符串为所有表头单元格设置一个固定的 className。Function({row, column, rowIndex, columnIndex})/String
header-cell-style表头单元格的 style 的回调方法,也可以使用一个固定的 Object 为所有表头单元格设置一样的 Style。Function({row, column, rowIndex, columnIndex})/Object
row-key行数据的 Key,用来优化 Table 的渲染;在使用 reserve-selection 功能与显示树形数据时,该属性是必填的。类型为 String 时,支持多层访问:user.info.id,但不支持 user.info[0].id,此种情况请使用 Function。Function(row)/String
empty-text空数据时显示的文本内容,也可以通过 slot="empty" 设置String暂无数据
default-expand-all是否默认展开所有行,当 Table 包含展开行存在或者为树形表格时有效Booleanfalse
expand-row-keys可以通过该属性设置 Table 目前的展开行,需要设置 row-key 属性才能使用,该属性为展开行的 keys 数组。Array
default-sort默认的排序列的 prop 和顺序。它的prop属性指定默认的排序的列,order指定默认排序的顺序Objectorder: ascending, descending如果只指定了prop, 没有指定order, 则默认顺序是ascending
tooltip-effecttooltip effect 属性Stringdark/light
show-summary是否在表尾显示合计行Booleanfalse
sum-text合计行第一列的文本String合计
summary-method自定义的合计计算方法Function({ columns, data })
span-method合并行或列的计算方法Function({ row, column, rowIndex, columnIndex })
select-on-indeterminate在多选表格中,当仅有部分行被选中时,点击表头的多选框时的行为。若为 true,则选中所有行;若为 false,则取消选择所有行Booleantrue
indent展示树形数据时,树节点的缩进Number16
lazy是否懒加载子节点数据Boolean
load加载子节点数据的函数,lazy 为 true 时生效,函数第二个参数包含了节点的层级信息Function(row, treeNode, resolve)
tree-props渲染嵌套数据的配置选项Object{ hasChildren: 'hasChildren', children: 'children' }

透传 Pagination 分页

参数说明类型可选值默认值
small是否使用小型分页样式Booleanfalse
background是否为分页按钮添加背景色Booleanfalse
page-size每页显示条目个数,支持 .sync 修饰符Number10
total总条目数Number
page-count总页数,total 和 page-count 设置任意一个就可以达到显示页码的功能;如果要支持 page-sizes 的更改,则需要使用 total 属性Number
pager-count页码按钮的数量,当总页数超过该值时会折叠Number大于等于 5 且小于等于 21 的奇数7
current-page当前页数,支持 .sync 修饰符Number1
layout组件布局,子组件名用逗号分隔Stringsizes, prev, pager, next, jumper, ->, total, slot'prev, pager, next, jumper, ->, total'
page-sizes每页显示个数选择器的选项设置Number[]10, 20, 30, 40, 50, 100
popper-class每页显示个数选择器的下拉框类名String
prev-text替代图标显示的上一页文字String
next-text替代图标显示的下一页文字String
disabled是否禁用Booleanfalse
hide-on-single-page只有一页时是否隐藏Boolean

自定义

参数说明类型可选值默认值
custom-class自定义类名String
is-show-head是否显示操作栏Booleanfalse
head-horizontal-layout头部水平布局方式Stringleft/end/rightend
head-vertical-layout头部垂直布局方式Stringtop/center/bottomcenter
is-able-config-col是否打开动态表头功能Booleanfalse
columns-id表头 id 空则不开启缓存String
check-list默认选中表头列表Array
limit-min-columns表头筛选最小限制Number1
config-col-icon动态表头筛选图标配置Object参数配置见下
columns表头数据Array参数配置见下
height-type表格高度撑开模式,adaptive父元素设置多少完全撑开;follow有多少显示多少,直到父元素设置的最大高度时表格内部产生滚动条;第三种为设置固定高度Stringadaptive/follow/normalfollow
is-show-foot是否显示底部Booleanfalse
is-fe-page是否采用前端结合分页Booleanfalse
request-page后端返回页数Number10
foot-horizontal-layout尾部水平布局方式Stringleft/end/rightend
foot-vertical-layout尾部垂直布局方式Stringtop/center/bottomcenter

config-col-icon

属性名说明类型可选值默认值
icon<i></i>图标路径Stringel-icon-s-operation
size图标大小Number16
color图标颜色String(hex)#3D7DFF

columns

透传 Element Table-column Attributes

参数说明类型可选值默认值
type对应列的类型。如果设置了 selection 则显示多选框;如果设置了 index 则显示该行的索引(从 1 开始计算);如果设置了 expand 则显示为一个可展开的按钮Stringselection/index/expand
index如果设置了 type=index,可以通过传递 index 属性来自定义索引number, Function(index)
column-keycolumn 的 key,如果需要使用 filter-change 事件,则需要此属性标识是哪个 column 的筛选条件String
label显示的标题String
prop对应列内容的字段名,也可以使用 property 属性String
width对应列的宽度String
min-width对应列的最小宽度,与 width 的区别是 width 是固定的,min-width 会把剩余宽度按比例分配给设置了 min-width 的列String
fixed列是否固定在左侧或者右侧,true 表示固定在左侧String, Booleantrue, left, right
render-header列标题 Label 区域渲染使用的 FunctionFunction(h, { column, $index })
sortable对应列是否可以排序,如果设置为 'custom',则代表用户希望远程排序,需要监听 Table 的 sort-change 事件Boolean, Stringtrue, false, 'custom'false
sort-method对数据进行排序的时候使用的方法,仅当 sortable 设置为 true 的时候有效,需返回一个数字,和 Array.sort 表现一致Function(a, b)
sort-by指定数据按照哪个属性进行排序,仅当 sortable 设置为 true 且没有设置 sort-method 的时候有效。如果 sort-by 为数组,则先按照第 1 个属性排序,如果第 1 个相等,再按照第 2 个排序,以此类推String/Array/Function(row, index)
sort-orders数据在排序时所使用排序策略的轮转顺序,仅当 sortable 为 true 时有效。需传入一个数组,随着用户点击表头,该列依次按照数组中元素的顺序进行排序Array数组中的元素需为以下三者之一:ascending 表示升序,descending 表示降序,null 表示还原为原始顺序'ascending', 'descending', null
resizable对应列是否可以通过拖动改变宽度(需要在 el-table 上设置 border 属性为真)Booleantrue
formatter用来格式化内容Function(row, column, cellValue, index)
show-overflow-tooltip当内容过长被隐藏时显示 tooltipBooleanfalse
align对齐方式Stringleft/center/rightleft
header-align表头对齐方式,若不设置该项,则使用表格的对齐方式Stringleft/center/right
class-name列的 classNameString
label-class-name当前列标题的自定义类名String
selectable仅对 type=selection 的列有效,类型为 Function,Function 的返回值用来决定这一行的 CheckBox 是否可以勾选Function(row, index)
reserve-selection仅对 type=selection 的列有效,类型为 Boolean,为 true 则会在数据更新之后保留之前选中的数据(需指定 row-key)Booleanfalse
filters数据过滤的选项,数组格式,数组中的元素需要有 text 和 value 属性。Array{ text, value }
filter-placement过滤弹出框的定位String与 Tooltip 的 placement 属性相同
filter-multiple数据过滤的选项是否多选Booleantrue
filter-method数据过滤使用的方法,如果是多选的筛选项,对每一条数据会执行多次,任意一次返回 true 就会显示。Function(value, row, column)
filtered-value选中的数据过滤项,如果需要自定义表头过滤的渲染方式,可能会需要此属性。Array

自定义

参数说明类型可选值默认值
render自定义列this.$createElement/h
header自定义列头this.$createElement/h

Events

透传 Table

事件名说明参数
select当用户手动勾选数据行的 Checkbox 时触发的事件selection, row
select-all当用户手动勾选全选 Checkbox 时触发的事件selection
selection-change当选择项发生变化时会触发该事件selection
cell-mouse-enter当单元格 hover 进入时会触发该事件row, column, cell, event
cell-mouse-leave当单元格 hover 退出时会触发该事件row, column, cell, event
cell-click当某个单元格被点击时会触发该事件row, column, cell, event
cell-dblclick当某个单元格被双击击时会触发该事件row, column, cell, event
row-click当某一行被点击时会触发该事件row, column, event
row-contextmenu当某一行被鼠标右键点击时会触发该事件row, column, event
row-dblclick当某一行被双击时会触发该事件row, column, event
header-click当某一列的表头被点击时会触发该事件column, event
header-contextmenu当某一列的表头被鼠标右键点击时触发该事件column, event
sort-change当表格的排序条件发生变化的时候会触发该事件{ column, prop, order }
filter-change当表格的筛选条件发生变化的时候会触发该事件,参数的值是一个对象,对象的 key 是 column 的 columnKey,对应的 value 为用户选择的筛选条件的数组filters
current-change当表格的当前行发生变化的时候会触发该事件,如果要高亮当前行,请打开表格的 highlight-current-row 属性currentRow, oldCurrentRow
header-dragend当拖动表头改变了列的宽度的时候会触发该事件newWidth, oldWidth, column, event
expand-change当用户对某一行展开或者关闭的时候会触发该事件(展开行时,回调的第二个参数为 expandedRows;树形表格时第二参数为 expanded)row, (expandedRowsexpanded)

透传 Pagination 分页

事件名说明参数
size-changepageSize 改变时会触发每页条数
prev-click用户点击上一页按钮改变当前页后触发当前页
next-click用户点击下一页按钮改变当前页后触发当前页

自定义

事件名说明参数
current-change-pagecurrentPage 改变时会触发当前页
tableHeadChange表头切换改变事件checkListBox
setNextData页码是后台返回页数的整倍数时 且 当前总数不超过所选页数

Methods 透传

方法名说明参数
clearSelection用于多选表格,清空用户的选择
toggleRowSelection用于多选表格,切换某一行的选中状态,如果使用了第二个参数,则是设置这一行选中与否(selected 为 true 则选中)row, selected
toggleAllSelection用于多选表格,切换所有行的选中状态
toggleRowExpansion用于可展开表格与树形表格,切换某一行的展开状态,如果使用了第二个参数,则是设置这一行展开与否(expanded 为 true 则展开)row, expanded
setCurrentRow用于单选表格,设定某一行为选中行,如果调用时不加参数,则会取消目前高亮行的选中状态。row
clearSort用于清空排序条件,数据会恢复成未排序的状态
clearFilter不传入参数时用于清空所有过滤条件,数据会恢复成未过滤的状态,也可传入由columnKey组成的数组以清除指定列的过滤条件columnKey
doLayout对 Table 进行重新布局。当 Table 或其祖先元素由隐藏切换为显示时,可能需要调用此方法
sort手动对 Table 进行排序。参数prop属性指定排序列,order指定排序顺序。prop: String, order: String

Slot

透传 Table

name说明
append插入至表格最后一行之后的内容,如果需要对表格的内容进行无限滚动操作,可能需要用到这个 slot。若表格有合计行,该 slot 会位于合计行之上。

透传 Pagination

name说明
pageSlot自定义内容,需要在 layout 中列出 slot

自定义

name说明
headLeft表格头部左侧插槽
headRight表格头部右侧插槽

使用

引入

安装

npm i jimi-table -S

main.js 导入

import JTable from "jimi-table";

Vue.use(JTable);

import "jimi-table/lib/j-table.css";

demo

<template>
  <div class="home">
    <j-table
      :data="tableData"
      :columns="columns"
      layout="total,prev,next,sizes"
      is-able-config-col
      is-show-foot
      :isTableFe="false"
    >
      <div slot="headLeft">
        <div>123</div>
      </div>
      <div slot="headRight">头部右侧</div>
    </j-table>
  </div>
</template>

<script>
export default {
  name: 'Home',
  data() {
    return {
      optionsDefault: [
        {
          key: 'geofence',
          label: '平台围栏',
          value: '0'
        },
        {
          key: 'geofence',
          label: '用户围栏',
          value: '8'
        },
        {
          key: 'blackCarAddressLibrary',
          label: '黑车库',
          value: '2'
        },
        {
          key: 'clockingIn',
          label: '考勤',
          value: '7'
        }
      ],
      tableData: [
        {
          date: 'ret',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1518 弄',
          type: '0'
        },
        {
          date: '2016-05-04',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1517 弄'
        },
        {
          date: '2016-05-01',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1519 弄'
        },
        {
          date: '2016-05-03',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1516 弄'
        },
        {
          date: 'ret',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1518 弄'
        },
        {
          date: '2016-05-04',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1517 弄'
        },
        {
          date: '2016-05-01',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1519 弄'
        },
        {
          date: '2016-05-03',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1516 弄'
        },
        {
          date: 'ret',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1518 弄'
        },
        {
          date: '2016-05-04',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1517 弄'
        },
        {
          date: '2016-05-01',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1519 弄'
        },
        {
          date: '2016-05-03',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1516 弄'
        },
        {
          date: 'ret',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1518 弄'
        },
        {
          date: '2016-05-04',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1517 弄'
        },
        {
          date: '2016-05-01',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1519 弄'
        },
        {
          date: '2016-05-03',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1516 弄'
        },
        {
          date: 'ret',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1518 弄'
        },
        {
          date: '2016-05-04',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1517 弄'
        },
        {
          date: '2016-05-01',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1519 弄'
        },
        {
          date: '2016-05-03',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1516 弄'
        },
        {
          date: 'ret',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1518 弄'
        },
        {
          date: '2016-05-04',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1517 弄'
        },
        {
          date: '2016-05-01',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1519 弄'
        },
        {
          date: '2016-05-03',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1516 弄'
        },
        {
          date: 'ret',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1518 弄'
        },
        {
          date: '2016-05-04',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1517 弄'
        },
        {
          date: '2016-05-01',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1519 弄'
        },
        {
          date: '2016-05-03',
          name: '王小虎',
          address: '上海市普陀区金沙江路 1516 弄'
        }
      ],
      columns: [
        {
          type: 'expand',
          width: '50px',
          align: 'left',
          render: (h, params) => {
            return h('span', {}, [
              h('div', {}, params.address),
              h('div', {}, params.geoname)
            ])
          }
        },
        {
          type: 'selection',
          width: '50px'
        },
        {
          label: '序号',
          type: 'index'
        },
        {
          label: '区域',
          prop: 'geoname',
          align: 'center',
          tooltip: true
        },
        {
          label: '地址',
          prop: 'address',
          align: 'center',
          tooltip: true,
          'min-width': '250px'
        },
        {
          label: '日期',
          prop: 'date',
          width: '120px',
          align: 'center',
          tooltip: true
        },
        {
          label: '类型',
          prop: 'type',
          width: '80px',
          align: 'left',
          tooltip: true,
          formatter: (row, column, cellValue) => {
            let optionItem = this.optionsDefault.find(
              (item) => item.value == cellValue
            )
            if (optionItem) {
              return optionItem.label
            } else {
              return '-'
            }
          }
        },
        {
          label: '测试仅有H-',
          prop: 'geoname1',
          width: '180px',
          align: 'center',
          tooltip: true,
          header: (h, params, column) => {
            return h('span', { style: 'color: red' }, column.label + 'header')
          }
        },
        {
          label: '测试有H和R-',
          prop: 'geoname2',
          minWidth: '200px',
          align: 'center',
          tooltip: true,
          header: (h, params, column) => {
            return h(
              'span',
              { style: 'color: red' },
              column.label + 'header+render'
            )
          },
          render(h, params) {
            return h(
              'span',
              { style: 'color: green' },
              params['name'] + 'test str'
            )
          }
        },
        {
          label: '测试 + render',
          prop: 'geoname3',
          width: '180px',
          align: 'center',
          tooltip: true,
          render(h, params) {
            return h('span', { style: 'color: blue' }, 'test render')
          }
        }
      ]
    }
  }
}
</script>