holyes-table 0.0.1

package/README.md

@@ -0,0 +1,613 @@
+# 组件说明
+
+这个是用@chenglou-pretext开发的虚拟滚动表格组件。
+
+## 优化
+
+1.用div+grid布局, 每一行的行高是通过@chenglou-pretext计算的, 这样不会触发 ResizeObserver 导致重排。
+
+2.大数据时, 会通过worker线程计算高度，然后逐渐渲染最大高度，提升首次渲染性能。
+
+3.表格支持激活时，保持滚动条位置。
+
+4.影响滚动性能的自定义插槽，增加配置lazyLoadSlot=true，用于延迟加载插槽内容，增加滚动性能。
+
+5.支持表头分组
+
+## 组件依赖
+
+- @chenglou-pretext ^0.0.5
+- vxe-pc-ui ^4.9.41
+- xe-utils ^4.0.4
+
+## 基本用法
+
+```vue
+<template>
+  <PretextTable
+    ref="pertextTableRef"
+    :columns="columns"
+    :height="400"
+    stripe
+    :row-config="{ isCurrent: true, isHover: true }"
+  />
+</template>
+
+<script setup>
+import { ref } from 'vue'
+const PretextTable = defineAsyncComponent(
+  () => import("@/components/pretextTable/pretextTable.vue")
+)
+
+const columns = ref([
+  { field: 'name', title: '姓名', width: 100 },
+  { field: 'age', title: '年龄', width: 80 },
+  { field: 'address', title: '地址', width: 200 }
+])
+
+const tableData = r[
+  { name: '张三', age: 25, address: '北京市朝阳区' },
+  { name: '李四', age: 30, address: '上海市浦东新区' }
+]
+
+const pertextTableRef = ref()
+
+// 重新设置数据
+pertextTableRef.value.reloadData(tableData)
+
+</script>
+```
+
+## Props 属性
+
+| 属性名 | 类型 | 默认值 | 说明 |
+| -------- | ------ | -------- | -------- |
+| columns | Array< PretextTableColumnPropsType> | [] | 表格列配置 |
+| height | Number | - | 表格高度 |
+| cellMinHeight | Number | 22 | 单元格最小行高 |
+| loading | Boolean | false | 是否显示加载状态 |
+| loadingConfig | Object | {} | 加载配置，包含text属性 |
+| lazyLoadSlot | Boolean | false | 自定义插槽是否懒加载，默认否；开启后，自定义插槽多时滚动会更流畅 |
+| rowConfig | Object | {} | 行配置，包含isCurrent（是否高亮当前行）和isHover（是否高亮悬停行） |
+| sortConfig | Object | {} | 排序配置，包含trigger（触发方式：cell（默认点击单元格排序）/default（默认点击图标排序）） |
+| stripe | Boolean | true | 是否显示斑马纹背景 |
+| showOverflow | String | "" | 是否显示溢出内容，可选值：title/tooltip/ellipsis/空 |
+| showFooter | Boolean | false | 是否显示表尾行 |
+| footerProps | Array< PretextTableFooterProps> | [] | 表尾行属性配置 |
+| treeConfig | PretextTableTreeConfig | {} | 树形结构配置项，详见下方说明 |
+| expandConfig | PretextTableExpandConfig | {} | 展开行配置项，详见下方说明 |
+
+### 列配置说明 (columns)
+
+列配置是表格的核心配置，支持以下属性：
+
+```typescript
+interface PretextTableColumnPropsType {
+  /** 字段名 */
+  field: string
+  /** 列标题 */
+  title: string
+  /** 列宽度 */
+  width?: number
+  /** 列最小宽度 */
+  minWidth?: number
+  /** 固定位置：left/right */
+  fixed?: 'left' | 'right' | ''
+  /** 是否可排序 */
+  sortable?: boolean
+  /** 列类型：seq(序号)/checkbox(多选) */
+  type?: 'seq' | 'checkbox'
+  /** 列样式 */
+  style?: any
+  /** 筛选配置 */
+  isFilter?: {
+    type: PretextTableFilterType
+    listOptions?: { label: string; value: PretextTableFilterlistOptions }[]
+  }
+  /** 是否可调整宽度 */
+  resizable?: boolean
+  /** 插槽配置 */
+  slots?: {
+    /** 自定义单元格插槽 */
+    default?: string
+    /** 插槽高度（有插槽时必填） */
+    defaultHeight?: number
+    /** 默认插槽类型：a(链接)/tag(标签)/icon(图标)/buttons(按钮组)/switch(开关) */
+    defaultType?: 'a' | 'tag' | 'icon' | 'buttons' | 'switch'
+    /** 插槽属性 */
+    defaultProps?: {
+      /** 标签插槽属性 */
+      tag?: {
+        /** 标签选项数组 */
+        options?: {
+          /** 标签状态 */
+          status?: 'primary' | 'success' | 'info' | 'warning' | 'error'
+          /** 标签颜色 */
+          color?: any
+          /** 标签显示的文本 */
+          label?: string
+          /** 标签对比的值 */
+          value: any
+        }[]
+      }
+      /** 图标插槽属性 */
+      icon?: {
+        /** 图标名称 */
+        name?: string
+        /** 图标样式 */
+        style?: any
+      }
+      /** 按钮组插槽属性 */
+      buttons?: {
+        /** 按钮组数组，每个元素是一行 div 的按钮数组 */
+        options?: {
+          /** 按钮内容 */
+          title?: string
+          /** 按钮提示 */
+          tip?: string
+          /** 按钮前缀图标 */
+          prefixIcon?: any
+          /** 按钮大小 */
+          size?: 'medium' | 'small' | 'mini'
+          /** 按钮类型 */
+          type?: 'primary' | 'danger'
+          /** 按钮样式 */
+          mode?: 'text' | 'button'
+          /** 按钮是否显示，取决于 row 的哪个字段 */
+          showField?: string
+          /** 按钮是否禁用，取决于 row 的哪个字段 */
+          disabledField?: string
+          /** 按钮是否加载中，取决于 row 的哪个字段 */
+          loadingField?: string
+          /** 按钮点击事件 */
+          onClick?: (row: any, index: number) => void
+          /** 其他参数 */
+          params?: any
+        }[][]
+      }
+      /** 开关插槽属性 */
+      switch?: {
+        /** 开关选中时显示的文本 */
+        checkedChildren?: string
+        /** 开关选中时显示的文本 */
+        openLabel?: string
+        /** 开关未选中时显示的文本 */
+        uncheckedChildren?: string
+        /** 开关未选中时显示的文本 */
+        closeLabel?: string
+        /** 开关选中时的值 */
+        checkedValue?: any
+        /** 开关未选中时的值 */
+        uncheckedValue?: any
+        /** 开关选中时的值 */
+        openValue?: any
+        /** 开关未选中时的值 */
+        closeValue?: any
+        /** 按钮是否显示，取决于 row 的哪个字段 */
+        showField?: string
+        /** 按钮是否禁用，取决于 row 的哪个字段 */
+        disabledField?: string
+        /** 按钮是否加载中，取决于 row 的哪个字段 */
+        loadingField?: string
+        /** 开关点击事件 */
+        onChange?: (row: any, index: number) => void
+      }
+    }
+    /** 表头插槽 */
+    header?: string
+    /** 表头插槽类型 */
+    headerType?: 'a'
+    /** 表尾插槽 */
+    footer?: string
+  }
+  /** 表尾配置 */
+  footer?: any[]
+  /** 子列（表头分组） */
+  children?: PretextTableColumnPropsType[]
+}
+```
+
+#### 列配置示例
+
+```javascript
+const columns = [
+  // 序号列
+  { type: 'seq', title: '序号', width: 60 },
+  
+  // 多选列
+  { type: 'checkbox', title: '选择', width: 60 },
+  
+  // 普通列
+  { field: 'name', title: '姓名', width: 100, sortable: true },
+  
+  // 固定列
+  { field: 'age', title: '年龄', width: 80, fixed: 'left' },
+  
+  // 自定义插槽列
+  {
+    field: 'status', 
+    title: '状态', 
+    width: 100,
+    slots: {
+      default: 'statusSlot',
+      defaultHeight: 32
+    }
+  },
+  
+  // 默认插槽类型列
+  {
+    field: 'link', 
+    title: '链接', 
+    width: 120,
+    slots: {
+      defaultType: 'a'
+    }
+  },
+  
+  // 表头分组
+  {
+    title: '联系信息',
+    children: [
+      { field: 'phone', title: '电话', width: 120 },
+      { field: 'email', title: '邮箱', width: 150 }
+    ]
+  }
+]
+```
+
+### 树形结构配置 (treeConfig)
+
+```typescript
+interface PretextTableTreeConfig {
+  /** 是否开启展开行功能 */
+  isOpenTree: boolean
+  /** 自动将列表转为树结构 */
+  transform?: boolean
+  /** 节点id字段, 默认是id */
+  idField?: string
+  /** 父节点字段, 默认是parentId */
+  parentField?: string
+  /** 子节点字段, 默认是children */
+  childrenField?: string
+  /** 树节点的缩进, 默认是20px */
+  indent?: number
+  /** 展开/收起的触发方式, 默认是default(点击按钮触发) */
+  trigger?: 'default' | 'cell' | 'row'
+  /** 是否懒加载 */
+  lazy?: boolean
+  /** 只对 lazy 启用后有效，标识是否存在子节点，从而控制是否允许被点击, 默认是hasChild */
+  hasChildField?: string
+  /** 懒加载方法 */
+  loadMethod?: (node: any) => any
+  /** 是否保留展开状态, 默认是false */
+  reserve?: boolean
+  /** 是否显示树形图标, 默认是true */
+  showIcon?: boolean
+}
+```
+
+#### 树形结构配置示例
+
+```javascript
+const treeConfig = {
+  transform: true,          // 自动将列表转为树结构
+  parentField: 'parentId',  // 父节点字段
+  childrenField: 'children', // 子节点字段
+  indent: 20,               // 缩进像素
+  trigger: 'default',       // 点击按钮触发展开/收起
+  showIcon: true            // 显示树形图标
+}
+```
+
+### 展开行配置 (expandConfig)
+
+```typescript
+interface PretextTableExpandConfig {
+  /** 是否开启展开行功能 */
+  isExpand: boolean
+  /** 展开行高度 (像素), 必填 */
+  height: number
+  /** 展开/收起的触发方式，默认是 default(点击按钮触发) */
+  trigger?: 'default' | 'cell' | 'row'
+  /** 展开行模式，默认是 undefined(展开行随着 x 轴滚动条滚动);
+   * inside(不随着 x 轴滚动条滚动) */
+  mode?: 'inside' | undefined
+  /** 插槽名称 */
+  slotName: string
+}
+```
+
+#### 展开行配置示例
+
+```javascript
+const expandConfig = {
+  isExpand: true,           // 开启展开行功能
+  height: 100,              // 展开行高度（必填）
+  trigger: 'default',       // 点击按钮触发展开/收起
+  mode: undefined,          // 展开行随着 x 轴滚动条滚动
+  slotName: 'expandSlot'    // 展开行插槽名称
+}
+```
+
+## Emits 事件
+
+| 事件名 | 参数 | 说明 |
+| -------- | ------ | -------- |
+| headerCellClick | (column: PretextTableColumnPropsType) | 点击表头单元格 |
+| cellClick | (row: any, column: PretextTableColumnPropsType) | 点击单元格 |
+| currentChange | (currentRow: any, oldCurrentRow: any) | 当前行变化 |
+| checkboxChange | (checked: boolean, row: any) | 多选列变化 |
+| checkboxAll | (checked: boolean) | 多选列全选 |
+| resizableChange | (column: PretextTableColumnPropsType, width: number) | 列调整宽度 |
+| toggleRowExpand | (rows: any[], expanded: boolean) | 展开/收起行 |
+
+## Methods 方法
+
+通过 `ref` 可以调用以下组件方法：
+
+| 方法名 | 参数 | 返回值 | 说明 |
+| -------- | ------ | -------- | -------- |
+| reloadData | `(data: any[])` | `Promise<void>` | 重新设置表格数据 |
+| getTableData | `()` | `{ fullData, visibleData }` | 获取表格数据（包含全部数据、当前可见数据） |
+| getCheckboxRecords | `()` | `any[]` | 获取所有选中的行数据 |
+| clearCheckboxRow | `()` | `void` | 清空多选列选中状态 |
+| updateFooter | `()` | `void` | 更新表尾行数据 |
+| updateFooterCellLabel | `(field: string, rowIndex: number, label: string)` | `void` | 更新表尾单元格文本 |
+| setTreeExpand | `(rows: any[], expanded: boolean)` | `void` | 设置树形节点展开/收起 |
+| setAllTreeExpand | `(isExpand: boolean)` | `void` | 设置所有树形节点展开/收起 |
+| clearTreeExpand | `()` | `void` | 清除所有树形节点展开状态 |
+| setRowExpand | `(rows: any[], expanded: boolean)` | `void` | 设置展开行展开/收起 |
+
+### 方法使用示例
+
+```vue
+<template>
+  <PretextTable
+    ref="pretextTableRef"
+    :columns="columns"
+    :data="tableData"
+  />
+  
+  <button @click="handleRefresh">刷新数据</button>
+  <button @click="handleGetSelected">获取选中行</button>
+  <button @click="handleClearExpand">清除树展开</button>
+</template>
+
+<script setup>
+import { ref } from 'vue'
+
+const pretextTableRef = ref()
+const tableData = ref([
+  { id: 1, name: '张三', parentId: null },
+  { id: 2, name: '李四', parentId: 1 }
+])
+
+/** 重新加载数据 */
+const reloadData = () => {
+  pretextTableRef.value?.reloadData(tableData.value)
+}
+
+/** 获取表格数据 */
+const getTableData = () => {
+  const tableData = pretextTableRef.value?.getTableData()
+  console.log('全部数据:', tableData.fullData)
+  console.log('当前可见数据:', tableData.visibleData)
+}
+
+/** 获取所有选中的行数据 */
+const getCheckboxRecords = () => {
+  const selectedRows = pretextTableRef.value?.getCheckboxRecords() || []
+  console.log('选中的行:', selectedRows)
+}
+
+/** 清空多选列选中状态 */
+const clearCheckboxRow = () => {
+  pretextTableRef.value?.clearCheckboxRow()
+}
+
+/** 更新表尾 */
+const updateFooter = () => {
+  pretextTableRef.value?.updateFooter()
+}
+
+/** 更新表尾单元格文本 */
+const updateFooterCell = () => {
+  pretextTableRef.value?.updateFooterCellLabel('name', 0, '合计')
+}
+
+/** 设置树形节点展开 */
+const setExpandTree = (row) => {
+  pretextTableRef.value.setTreeExpand([row], true)
+}
+
+/** 清除树形展开状态 */
+const clearTreeExpand = () => {
+  pretextTableRef.value?.clearTreeExpand()
+}
+
+/** 设置所有树形节点展开/收起 */
+const setAllTreeExpand = (isExpand: boolean) => {
+  pretextTableRef.value.setAllTreeExpand(isExpand)
+}
+
+/** 设置展开行 */
+const setExpandRow = (row,expanded: boolean) => {
+  pretextTableRef.value.setRowExpand([row], expanded)
+}
+
+</script>
+```
+
+## 插槽使用
+
+### 自定义插槽
+
+```vue
+<PretextTable
+  :columns="columns"
+  :data="tableData"
+>
+  <!-- 自定义状态插槽 -->
+  <template #status_default="{ row, column }">
+    <span :class="`status-${row.status}`">
+      {{ row.status === 'active' ? '活跃' : '禁用' }}
+    </span>
+  </template>
+
+  <!-- 自定义表头插槽 -->
+  <template #status_header="{ column }">
+    <div style="display: flex; align-items: center;">
+      <span>{{ column.title }}</span>
+      <vxe-icon name="question" style="margin-left: 4px;" />
+    </div>
+  </template>
+
+  <!-- 自定义底部插槽 -->
+  <template #status_footer="{ column }">
+    <span>123</span>
+  </template>
+</PretextTable>
+
+<script setup>
+const columns = [
+  // 自定义插槽
+  {
+    field: 'status',
+    title: '状态',
+    width: 100,
+    slots: {
+      header: 'status_header',
+      default: 'status_default',
+      defaultHeight: 32,  // 必须指定插槽高度
+      footer: "status_footer"
+    }
+  }
+]
+</script>
+```
+
+### 默认插槽类型
+
+组件内置了多种默认插槽类型，无需自定义插槽：
+
+1. **链接类型 (a)**: 自动渲染为链接样式
+2. **标签类型 (tag)**: 自动渲染为标签样式
+3. **图标类型 (icon)**: 自动渲染为图标
+4. **按钮组类型 (buttons)**: 自动渲染为按钮组
+5. **开关类型 (switch)**: 自动渲染为开关
+
+```javascript
+const columns = [
+  // 链接类型
+  {
+    field: 'link',
+    title: '链接',
+    slots: {
+      defaultType: 'a'  // 自动渲染为链接
+    }
+  },
+  
+  // 标签类型
+  {
+    field: 'tags',
+    title: '标签',
+    slots: {
+      defaultType: 'tag',  // 自动渲染为标签
+      defaultProps: {
+        tag: {
+          options: [
+            { label: '活跃', value: '1', status: 'success' },
+            { label: '禁用', value: '0', status: 'warning' }
+          ]
+        }
+      }
+    }
+  },
+  
+  // 图标类型
+  {
+    field: 'icon',
+    title: '图标',
+    slots: {
+      defaultType: 'icon',
+      defaultProps: {
+        icon: {
+          name: 'success',  // 图标名称
+          style: { color: 'green' }  // 图标样式
+        }
+      }
+    }
+  },
+  
+  // 按钮组类型
+  {
+    field: 'buttons',
+    title: '操作',
+    slots: {
+      defaultType: 'buttons',
+      defaultProps: {
+        buttons: {
+          options: [
+            [
+              {
+                title: '编辑',
+                type: 'primary',
+                onClick: (row, index) => {
+                  console.log('编辑', row)
+                }
+              },
+              {
+                title: '删除',
+                type: 'danger',
+                onClick: (row, index) => {
+                  console.log('删除', row)
+                }
+              }
+            ]
+          ]
+        }
+      }
+    }
+  },
+  
+  // 开关类型
+  {
+    field: 'status',
+    title: '状态',
+    slots: {
+      defaultType: 'switch',
+      defaultProps: {
+        switch: {
+          checkedChildren: '开',
+          uncheckedChildren: '关',
+          checkedValue: true,
+          uncheckedValue: false,
+          onChange: (row, index) => {
+            console.log('开关变化', row)
+          }
+        }
+      }
+    }
+  }
+]
+```
+
+## 注意事项
+
+1 **自定义插槽**
+
+- 已经默认配置了一些单元格类型 defaultType，不一定都需要自定义插槽。
+- 如果确实需要自定义插槽，必须填写插槽的高度defaultHeight，最好定死列宽度，因为整个表格的高度是根据 @chenglou-pretext 计算的，能准确计算出每一行的行高。
+
+2 **性能优化**
+
+- 大数据量时建议设置 `lazyLoadSlot=true` 延迟加载自定义插槽内容
+- 避免在自定义插槽中执行复杂计算或频繁更新的操作
+- 合理使用 `cellMinHeight` 控制最小行高，避免行高计算不准确
+
+3 **样式定制**
+
+- 表格使用 CSS Grid 布局，可以通过 CSS 变量自定义样式
+- 支持斑马纹、悬停高亮、当前行高亮等样式配置
+- 表头支持固定定位，滚动时保持可见
+- 暂不支持自定义文字大小，会影响@chenglou-pretext 计算行高

package/dist/index.js

@@ -0,0 +1,21 @@
+import { createElementBlock as e, openBlock as t } from "vue";
+//#region lib/aa/aa.vue?vue&type=script&lang.ts
+var n = {
+	inheritAttrs: !1,
+	name: "aa"
+}, r = (e, t) => {
+	let n = e.__vccOpts || e;
+	for (let [e, r] of t) n[e] = r;
+	return n;
+};
+//#endregion
+//#region lib/aa/aa.vue
+function i(n, r, i, a, o, s) {
+	return t(), e("div", null, " 123 ");
+}
+var a = /* @__PURE__ */ r(n, [["render", i]]), o = a;
+o.install = (e) => {
+	e.component("HolyesTable", o);
+};
+//#endregion
+export { a as aa, o as default };

package/dist/lib/aa/aa.vue.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import('vue').DefineComponent<{}, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/lib/main.d.ts

@@ -0,0 +1,7 @@
+import { App } from 'vue';
+import { default as aa } from './aa/aa.vue';
+export { aa };
+declare const HolyesTable: typeof aa & {
+    install: (app: App) => void;
+};
+export default HolyesTable;

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "holyes-table",
+  "version": "0.0.1",
+  "type": "module",
+  "description": "合力思虚拟滚动表格组件",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/lib/main.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/lib/main.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "vue-tsc --noEmit && vite build",
+    "prepublishOnly": "pnpm run build",
+    "登录npm": "npm login --registry https://registry.npmjs.org",
+    "发布npm": "npm publish --registry https://registry.npmjs.org",
+    "退出npm登录": "npm logout --registry https://registry.npmjs.org",
+    "查看npm登录": "npm whoami --registry https://registry.npmjs.org",
+    "补丁更新": "npm version patch --registry https://registry.npmjs.org",
+    "小功能更新": "npm version minor --registry https://registry.npmjs.org",
+    "大版本更新": "npm version major --registry https://registry.npmjs.org"
+  },
+  "peerDependencies": {
+    "vue": "^3.3.13",
+    "xe-utils": "^4.0.4",
+    "vxe-pc-ui": "^4.9.41"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-vue": "^6.0.6",
+    "typescript": "~6.0.2",
+    "vite": "^8.0.3",
+    "vite-plugin-dts": "^5.0.0",
+    "vue": "^3.5.34",
+    "vue-tsc": "^2.2.12"
+  }
+}