useTable.ts 3.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145
  1. import { Table } from "./interface";
  2. import { reactive, computed, toRefs } from "vue";
  3. /**
  4. * @description table 页面操作方法封装
  5. * @param {Function} api 获取表格数据 api 方法 (必传)
  6. * @param {Object} initParam 获取数据初始化参数 (非必传,默认为{})
  7. * @param {Boolean} isPageable 是否有分页 (非必传,默认为true)
  8. * @param {Function} dataCallBack 对后台返回的数据进行处理的方法 (非必传)
  9. * */
  10. export const useTable = (
  11. api?: (params: any) => Promise<any>,
  12. initParam: object = {},
  13. isPageable: boolean = true,
  14. dataCallBack?: (data: any) => any,
  15. requestError?: (error: any) => void
  16. ) => {
  17. const state = reactive<Table.StateProps>({
  18. // 表格数据
  19. tableData: [],
  20. // 分页数据
  21. pageable: {
  22. // 当前页数
  23. pageNum: 1,
  24. // 每页显示条数
  25. pageSize: 10,
  26. // 总条数
  27. total: 0
  28. },
  29. // 查询参数(只包括查询)
  30. searchParam: {},
  31. // 初始化默认的查询参数
  32. searchInitParam: {},
  33. // 总参数(包含分页和查询参数)
  34. totalParam: {}
  35. });
  36. /**
  37. * @description 分页查询参数(只包括分页和表格字段排序,其他排序方式可自行配置)
  38. * */
  39. const pageParam = computed({
  40. get: () => {
  41. return {
  42. pageNum: state.pageable.pageNum,
  43. pageSize: state.pageable.pageSize
  44. };
  45. },
  46. set: (newVal: any) => {
  47. console.log("我是分页更新之后的值", newVal);
  48. }
  49. });
  50. /**
  51. * @description 获取表格数据
  52. * @return void
  53. * */
  54. const getTableList = async () => {
  55. if (!api) return;
  56. try {
  57. // 先把初始化参数和分页参数放到总参数里面
  58. Object.assign(state.totalParam, initParam, isPageable ? pageParam.value : {});
  59. let { data } = await api({ ...state.searchInitParam, ...state.totalParam });
  60. console.log("data11", data);
  61. dataCallBack && (data = dataCallBack(data));
  62. state.tableData = isPageable ? data.list : data;
  63. // 解构后台返回的分页数据 (如果有分页更新分页信息)
  64. if (isPageable) {
  65. state.pageable.total = data.total;
  66. }
  67. } catch (error) {
  68. requestError && requestError(error);
  69. }
  70. };
  71. /**
  72. * @description 更新查询参数
  73. * @return void
  74. * */
  75. const updatedTotalParam = () => {
  76. state.totalParam = {};
  77. // 处理查询参数,可以给查询参数加自定义前缀操作
  78. let nowSearchParam: Table.StateProps["searchParam"] = {};
  79. // 防止手动清空输入框携带参数(这里可以自定义查询参数前缀)
  80. for (let key in state.searchParam) {
  81. // 某些情况下参数为 false/0 也应该携带参数
  82. if (state.searchParam[key] || state.searchParam[key] === false || state.searchParam[key] === 0) {
  83. nowSearchParam[key] = state.searchParam[key];
  84. }
  85. }
  86. Object.assign(state.totalParam, nowSearchParam);
  87. };
  88. /**
  89. * @description 表格数据查询
  90. * @return void
  91. * */
  92. const search = () => {
  93. state.pageable.pageNum = 1;
  94. updatedTotalParam();
  95. getTableList();
  96. };
  97. /**
  98. * @description 表格数据重置
  99. * @return void
  100. * */
  101. const reset = () => {
  102. state.pageable.pageNum = 1;
  103. // 重置搜索表单的时,如果有默认搜索参数,则重置默认的搜索参数
  104. state.searchParam = { ...state.searchInitParam };
  105. updatedTotalParam();
  106. getTableList();
  107. };
  108. /**
  109. * @description 每页条数改变
  110. * @param {Number} val 当前条数
  111. * @return void
  112. * */
  113. const handleSizeChange = (val: number) => {
  114. state.pageable.pageNum = 1;
  115. state.pageable.pageSize = val;
  116. getTableList();
  117. };
  118. /**
  119. * @description 当前页改变
  120. * @param {Number} val 当前页
  121. * @return void
  122. * */
  123. const handleCurrentChange = (val: number) => {
  124. state.pageable.pageNum = val;
  125. getTableList();
  126. };
  127. return {
  128. ...toRefs(state),
  129. getTableList,
  130. search,
  131. reset,
  132. handleSizeChange,
  133. handleCurrentChange,
  134. updatedTotalParam
  135. };
  136. };