@peng_kai/kit 0.1.9 → 0.1.11

package/antd/hooks/useAntdTable.ts

@@ -1,82 +1,115 @@
-import { computed, reactive } from 'vue';
-import type { UseQueryReturnType } from '@tanstack/vue-query';
-import type { Table, TableProps } from 'ant-design-vue';
-import type { ColumnType } from 'ant-design-vue/es/table/interface';
-import type { ComponentProps } from 'vue-component-type-helpers';
-
-export function useAntdTable<
-  UQRR extends UseQueryReturnType<any, any>,
-  QP extends Partial<{ page?: string | number, page_size?: string | number }>,
->(uqrt: UQRR, queryParams: QP = ({} as any)) {
-  type RecordType = GetRecordType<UQRR>;
-  type LocalTableProps = TableProps<RecordType>;
-  type LocalColumnsType = NonNullable<LocalTableProps['columns']>;
-  type LocalTableRowSelection = NonNullable<LocalTableProps['rowSelection']>;
-
-  const { data, isFetching, isLoading } = uqrt;
-
-  const onPaginationChange: ComponentProps<typeof Table>['onChange'] = (pagination) => {
-    const page = queryParams.page_size !== pagination.pageSize ? 1 : pagination.current;
-    Object.assign(queryParams, { page, page_size: pagination.pageSize ?? 10 });
-  };
-  const defineColumns = (columnsGetter: () => LocalColumnsType) => computed(columnsGetter);
-  const defineRowSelection = (rowSelectionGetter: () => LocalTableRowSelection) => {
-    const rowSelection = reactive(rowSelectionGetter());
-
-    rowSelection.selectedRowKeys ??= [];
-    rowSelection.onChange ??= keys => rowSelection.selectedRowKeys = keys;
-
-    return rowSelection;
-  };
-
-  const tableProps = computed<LocalTableProps>(() => {
-    const { list, pagination } = data.value ?? {};
-
-    return {
-      dataSource: list,
-      pagination: {
-        disabled: isFetching.value,
-        current: Number(queryParams.page ?? 1),
-        pageSize: Number(queryParams.page_size ?? 10),
-        total: pagination?.total ?? 0,
-        showTotal: total => `共 ${total} 条`,
-      },
-      loading: isLoading.value,
-      scroll: { x: 'max-content' },
-      sticky: true,
-      onChange: onPaginationChange as any,
-    };
-  });
-  const dataIndexs = new Proxy({} as Record<keyof RecordType, string>, {
-    get(_, p) {
-      return p;
-    },
-  });
-  const bodyCellType = {} as {
-    index: number
-    text: any
-    value: any
-    record: RecordType
-    column: ColumnType<RecordType>
-  };
-
-  return {
-    /** ATable 的预设 Props */
-    tableProps,
-    /** 【类型辅助】基于接口数据类型推导出的 dataIndex，供 columns 的 dataIndex 使用 */
-    dataIndexs,
-    /** 【类型辅助】bodyCell 插槽数据的精确类型描述 */
-    bodyCellType,
-    /** 【类型辅助】用于定义出类型精确的 columns  */
-    defineColumns,
-    /** 【类型辅助】用于定义出类型精确的 rowSelection  */
-    defineRowSelection,
-    onPaginationChange,
-  };
-}
-
-type GetRecordType<T> = T extends UseQueryReturnType<infer D, any>
-  ? D extends Api.PageData
-    ? NonNullable<D['list']>[0]
-    : never
-  : never;
+import { computed, reactive, ref } from 'vue';
+import { pick } from 'lodash-es';
+import type { UseQueryReturnType } from '@tanstack/vue-query';
+import type { Table, TableProps } from 'ant-design-vue';
+import type { ColumnType, FilterValue } from 'ant-design-vue/es/table/interface';
+import type { ComponentProps } from 'vue-component-type-helpers';
+
+interface ISorter {
+  field?: string
+  order?: string
+}
+
+export function useAntdTable<
+  UQRR extends UseQueryReturnType<any, any>,
+  QP extends Partial<{ page?: string | number, page_size?: string | number }>,
+>(uqrt: UQRR, queryParams: QP = ({} as any)) {
+  type RecordType = GetRecordType<UQRR>;
+  type LocalTableProps = TableProps<RecordType>;
+  type LocalColumnsType = NonNullable<LocalTableProps['columns']>;
+  type LocalTableRowSelection = NonNullable<LocalTableProps['rowSelection']>;
+
+  const { data, isFetching, isLoading } = uqrt;
+  const filters = ref<Record<string, FilterValue>>();
+  const sorter = ref<ISorter>();
+  const sorters = ref<ISorter[]>();
+
+  const onChange: ComponentProps<typeof Table>['onChange'] = (_pagination, _filters, _sorter, extra) => {
+    if (extra.action === 'paginate') {
+      const page = queryParams.page_size !== _pagination.pageSize ? 1 : _pagination.current;
+      Object.assign(queryParams, { page, page_size: _pagination.pageSize ?? 10 });
+    }
+    else if (extra.action === 'filter') {
+      filters.value = _filters;
+    }
+    else if (extra.action === 'sort') {
+      if (Array.isArray(_sorter)) {
+        sorter.value = pick(_sorter[0], ['field', 'order']) as any;
+        sorters.value = _sorter.map(item => pick(item, ['field', 'order'])) as any;
+      }
+      else {
+        sorter.value = pick(_sorter, ['field', 'order']) as any;
+        sorters.value = [{ ...sorter.value }];
+      }
+    }
+  };
+  const defineColumns = (columnsGetter: () => LocalColumnsType) => computed(columnsGetter);
+  const defineRowSelection = (rowSelectionGetter: () => LocalTableRowSelection) => {
+    const rowSelection = reactive(rowSelectionGetter());
+
+    rowSelection.selectedRowKeys ??= [];
+    rowSelection.onChange ??= keys => rowSelection.selectedRowKeys = keys;
+
+    return rowSelection;
+  };
+
+  const tableProps = computed<LocalTableProps>(() => {
+    const { list, pagination } = data.value ?? {};
+
+    return {
+      dataSource: list,
+      pagination: {
+        disabled: isFetching.value,
+        current: Number(queryParams.page ?? 1),
+        pageSize: Number(queryParams.page_size ?? 10),
+        total: pagination?.total ?? 0,
+        showSizeChanger: true,
+        showQuickJumper: true,
+        showTotal: total => `共 ${total} 条`,
+      },
+      loading: isLoading.value,
+      scroll: { x: 'max-content' },
+      sticky: true,
+      onChange: onChange as any,
+    };
+  });
+  const dataIndexs = new Proxy({} as Record<keyof RecordType, string>, {
+    get(_, p) {
+      return p;
+    },
+  });
+  const bodyCellType = {} as {
+    index: number
+    text: any
+    value: any
+    record: RecordType
+    column: ColumnType<RecordType>
+  };
+
+  return {
+    /** ATable 的预设 Props */
+    tableProps,
+    /* 过滤的字段 */
+    filters,
+    /* 排序的字段 */
+    sorter,
+    /* 多维排序的字段 */
+    sorters,
+    /** 【类型辅助】基于接口数据类型推导出的 dataIndex，供 columns 的 dataIndex 使用 */
+    dataIndexs,
+    /** 【类型辅助】bodyCell 插槽数据的精确类型描述 */
+    bodyCellType,
+    /** 【类型辅助】用于定义出类型精确的 columns  */
+    defineColumns,
+    /** 【类型辅助】用于定义出类型精确的 rowSelection  */
+    defineRowSelection,
+    /** 内置的 ATable onChange 事件，默认在 `tableProps` 中 */
+    onChange,
+  };
+}
+
+type GetRecordType<T> = T extends UseQueryReturnType<infer D, any>
+  ? D extends Api.PageData
+    ? NonNullable<D['list']>[0]
+    : never
+  : never;

package/package.json

@@ -1,55 +1,55 @@
-{
-  "name": "@peng_kai/kit",
-  "type": "module",
-  "version": "0.1.9",
-  "description": "",
-  "author": "",
-  "license": "ISC",
-  "keywords": [],
-  "main": "index.js",
-  "scripts": {
-    "lint": "eslint .",
-    "lint:fix": "eslint . --fix"
-  },
-  "peerDependencies": {
-    "@tanstack/vue-query": "4.37.1",
-    "@vueuse/core": "10.6.1",
-    "ant-design-vue": "4.0.7",
-    "axios": "1.6.2",
-    "bignumber.js": "9.1.2",
-    "dayjs": "1.11.10",
-    "lodash-es": "4.17.21",
-    "vue": "3.3.8",
-    "vue-router": "4.2.5"
-  },
-  "dependencies": {
-    "@babel/generator": "^7.23.5",
-    "@babel/parser": "^7.23.5",
-    "@babel/traverse": "^7.23.5",
-    "@babel/types": "^7.23.5",
-    "@tanstack/vue-query": "^4.37.1",
-    "@vueuse/core": "^10.6.1",
-    "a-calc": "^1.3.8",
-    "ant-design-vue": "^4.0.7",
-    "axios": "^1.6.2",
-    "bignumber.js": "^9.1.2",
-    "chokidar": "^3.5.3",
-    "dayjs": "^1.11.10",
-    "fast-glob": "^3.3.2",
-    "lodash-es": "^4.17.21",
-    "nprogress": "^0.2.0",
-    "vue": "^3.3.8",
-    "vue-router": "^4.2.5"
-  },
-  "devDependencies": {
-    "@antfu/eslint-config": "^1.2.1",
-    "@peng_kai/lint": "^0.1.0",
-    "@types/lodash-es": "^4.17.11",
-    "@types/node": "18",
-    "@types/nprogress": "^0.2.3",
-    "@unocss/eslint-plugin": "^0.57.7",
-    "type-fest": "^4.8.1",
-    "typescript": "^5.2.2",
-    "vue-component-type-helpers": "^1.8.22"
-  }
-}
+{
+  "name": "@peng_kai/kit",
+  "type": "module",
+  "version": "0.1.11",
+  "description": "",
+  "author": "",
+  "license": "ISC",
+  "keywords": [],
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix"
+  },
+  "peerDependencies": {
+    "@tanstack/vue-query": "4.37.1",
+    "@vueuse/core": "10.6.1",
+    "ant-design-vue": "4.0.8",
+    "axios": "1.6.2",
+    "bignumber.js": "9.1.2",
+    "dayjs": "1.11.10",
+    "lodash-es": "4.17.21",
+    "vue": "3.3.8",
+    "vue-router": "4.2.5"
+  },
+  "dependencies": {
+    "@babel/generator": "^7.23.5",
+    "@babel/parser": "^7.23.5",
+    "@babel/traverse": "^7.23.5",
+    "@babel/types": "^7.23.5",
+    "@tanstack/vue-query": "^4.37.1",
+    "@vueuse/core": "^10.6.1",
+    "a-calc": "^1.3.8",
+    "ant-design-vue": "^4.0.8",
+    "axios": "^1.6.2",
+    "bignumber.js": "^9.1.2",
+    "chokidar": "^3.5.3",
+    "dayjs": "^1.11.10",
+    "fast-glob": "^3.3.2",
+    "lodash-es": "^4.17.21",
+    "nprogress": "^0.2.0",
+    "vue": "^3.3.8",
+    "vue-router": "^4.2.5"
+  },
+  "devDependencies": {
+    "@antfu/eslint-config": "^1.2.1",
+    "@peng_kai/lint": "^0.1.0",
+    "@types/lodash-es": "^4.17.11",
+    "@types/node": "18",
+    "@types/nprogress": "^0.2.3",
+    "@unocss/eslint-plugin": "^0.57.7",
+    "type-fest": "^4.8.1",
+    "typescript": "^5.2.2",
+    "vue-component-type-helpers": "^1.8.22"
+  }
+}