2.0.0 • Published 2 years ago

table-form-list v2.0.0

Weekly downloads
2
License
ISC
Repository
github
Last release
2 years ago

components => tablelist基于element-ui对table表格的二次封装,一个快速生成查询列表的封装组件

注意:本包是vue项目;全局引入: 本包需依赖element-ui组件库。包构建并没有将element-ui等生产依赖进行打包,避免造成重复依赖

安装使用
// 添加项目依赖: npm install table-form-list -S
// main.js中引入
1. import router from "./router";
2. import ElementUi from 'element-ui';
3. import "element-ui/lib/theme-chalk/index.css";
4. import TableFormList from "table-form-list"
5. import 'table-form-list/dist/theme-chalk/index.css';
6. Vue.use(TableFormList);

灵活使用,复制项目文件中的lib/TableFormList.vue文件在自己项目中,方便更改扩展

table-form-list

使用案例
  • 指定表格的数据源 dataSource 为一个数组,配置相关属性json;
<template>
  <div>
    <span>本地测试引入表格组件库开发</span>
    <br />
    <TableList
      border
      :options="options"
      :value="formVal"
      :rules="rules"
      :search="tableSearch"
      :columns="columns"
      :dataSource="dataSource"
      :extendButton="extendButton(this)"
      :operates="operates(this)"
      :pagination="pagination"
    />
  </div>
</template>

<script>
// 搜索设置
const tableSearch = [
  {
    label: "姓名ID/手机号",
    inputType: "number",
    maxlength: 11,
    value: "name",
    rulesLength: true,
    labelProps: {
      "label-width": "130"
    }
  },
  {
    type: "select",
    label: "是否添加微信",
    value: "joinWeChatStatus",
    children: [
      {
        label: "未添加",
        value: "1"
      },
      {
        label: "已添加",
        value: "0"
      }
    ]
  },
  {
    type: "picker",
    label: "操作时间",
    value: "operate",
    props: {
      size: "mini",
      type: "datetimerange",
      "range-separator": "至",
      "start-placeholder": "开始日期",
      "end-placeholder": "结束日期",
      "value-format": "timestamp"
    }
  },
   {
    type: "cascader",
    label: "城市",
    value: "city",
    props: {
      size: "mini",
      expandTrigger: 'hover'
    },
    options: []
  }
];

// 表格头设置
const columns = [
  {
    label: "姓名",
    prop: "name",
    props: {
      sortable: "sortable"
    }
  },
  {
    label: "性别",
    prop: "sex",
    formatter: (row, column, index) => {
      return row.sex === 0 ? "男" : "女";
    }
  },
  {
    label: "住址",
    prop: "address",
    newjump: (row, columns, index) => {
      return `www.baidu.com/studentInfo/index/${row.accountId}`;
    }
  },
  {
    label: "手机号",
    render: (h, parmas) => {
      return [
        h("i", {
          class: "el-icon-phone-outline",
          style: "fontSize: 16px; color: red"
        }),
        h("span", parmas.row.mobileNum)
      ];
    }
  }
];

// 表格操作按钮
const operates = that => [
  {
    label: "编辑",
    isShow: row => {
      return row.status !== 2;
    },
    disabled: row => {
      return row.disabled === 2;
    },
    method: row => {
      that.handleNewJump(row);
    }
  }
];

// 服务器请求返回值
const dataSource = [
  {
    key: "1",
    name: "胡彦斌",
    age: 32,
    sex: 0,
    address: "西湖区湖底公园1号"
  },
  {
    key: "2",
    name: "胡彦祖",
    age: 42,
    sex: 1,
    disabled: 2,
    address: "西湖区湖底公园1号"
  }
];

// 表格扩展按钮
const extendButton = (that) => [{
  title: '批量导入',
  method: () => that.handleBatchCourse()
}]

export default {
  data() {
    return {
      columns,
      operates,
      dataSource,
      tableSearch,
      extendButton,
      formVal: {
        name: 18335
      },
      options: {
        index: true,
        labelIndex: '序号',
        pageExtend: {
         layout: 'total, sizes, ->, prev, pager, next, jumper'
        }
      },
      rules: {
        name: [
          { required: true, message: "请填写学生ID", trigger: "blur" }
        ]
      },
      pagination: {
        currentPage: 1,
        pageSize: 10
      }
    };
  },

  methods: {
    handleBatchCourse() {
      console.log('点击批量导入按钮')
    }
  }
};
</script>
API使用
TableList
参数说明类型默认值必填项
index是否显示该行索引String-
isLayout搜索条件是否启用Row/Col布局Booleantrue
border是否展示外边框和列边框Booleanfalse
loading页面是否加载中Booleanfalse
optionstable参数扩展属性(复选框等)Table AttributesObject-
columns表格列的配置描述,表头部分Array[]-
dataSource数据数组Array[]-
pagination分页的配置项Object-
dataTotal数据总数Number0
operates操作列表按钮Array[]-
extendButton列表扩展按钮,eg:导出、批量等按钮Array[]-
search表格搜索条件Array[]-
Columns

列描述数据对象,是 columns 中的一项,与Element-Ui Columns 使用相同的 API在props中填写。使用用法:

参数说明类型默认值必填项
label列头显示文字String-
prop列数据在数据项中对应的 keyString-
align设置列的对齐方式'left' 'right' 'center''left'
width列宽度string number-
props列表参数扩展属性Table-column AttributesObject-
render生成复杂数据的渲染函数,参数分别为createElement,当前行数据Function(h, record) {}-
formatter数据格式化Function(row, columns, index) {}-
newjumpurl页面跳转Function(row, columns, index) {}-
const columns = [
{
  label: '姓名',
  prop: 'name',
  props: {
    sortable: 'sortable',
  }
}]
tableSearch type []

列表搜索条件对象描述,同FormItem API相同,同理在props中填写。使用用法:

参数说明类型默认值必填项
label表单label名称String-
value表单名称对应的keyString-
type表单类型(可选:select/picker/cascader)Stringinput
inputTypeinput type: numberString'number'
maxlength最大输入的长度'string' 'number'-
rulesLength输入文本校验长度控制Boolean-
children展示有子选项值type:selectArray[]-
props任意表单的属性扩展Object-
rules是否添加搜索条件的校验Object-
handleSearch数据验证成功后回调事件Function(e:Event)-
handleReset重置所有组件Function()-
const tableSearch = [{
  type: "picker",
  label: "操作时间",
  value: "operate",
  props: {
    size: "mini",
    type: "datetimerange",
    "range-separator": "至",
    "start-placeholder": "开始日期",
    "end-placeholder": "结束日期",
    "value-format": "timestamp"
    }
  },
  {
    type: "cascader",
    label: "城市",
    value: "city",
    props: {
      size: "mini",
      expandTrigger: 'hover'
    },
    options: []
  }
options type {}

列表复选框、序列号、操作列表宽度、slot自定义操作按钮等

参数说明类型默认值必填项
label复选框文本显示String-
width操作按钮宽度Number-
index序列号Booleanfalse
selection复选框显示Booleanfalse
labelIndex序列号文本显示String-
slotcontent自定义操作按钮Element-Button-
pageExtend自定义分页Object-
operates type []

列表操作列对象描述,使用用法:

参数说明类型默认值必填项
label列文本显示String-
typebutton按钮类型Stringtext
icon按钮icon图标String-
plain是否朴素按钮Booleanfalse
isShow依据状态是否显示,第一个参数当前行数据,第二个参数当前行索引Function(row, index) {}-
disabled是否禁用状态Function(row, index) {}-
methodevent 事件Function(row, index) {}-
TableList Events
事件名说明类型默认值必填项
current-change页码改变的回调,参数是改变后的页码及每页条数Function(currentPage)-
size-change每页条数改变的回调,参数是改变后的页码及每页条数Function(size)-
handleSelectionChange当选择项发生变化时会触发该事件Function(selection)-
toggleRowSelection设置当前选中项回显、清空复选框事件Function(dom节点)-
exportBut type[]

列表导出等对象操作描述,使用用法:

参数说明类型默认值必填项
title按钮文本显示String-
href下载链接String-
methodevent 事件Function() {}-