ep-craft 0.1.42 → 0.2.0

package/dist-ai/components/table.json

@@ -0,0 +1,734 @@
+{
+  "entry": {
+    "category": "data",
+    "events": [
+      {
+        "description": "当用户手动勾选数据行的 Checkbox 时触发",
+        "name": "select",
+        "params": "(selection, row)"
+      },
+      {
+        "description": "当用户手动勾选全选 Checkbox 时触发",
+        "name": "selectAll",
+        "params": "(selection)"
+      },
+      {
+        "description": "当选择项发生变化时触发",
+        "name": "selectionChange",
+        "params": "(selection)"
+      },
+      {
+        "description": "当单元格 hover 进入时触发",
+        "name": "cellMouseEnter",
+        "params": "(row, column, cell, event)"
+      },
+      {
+        "description": "当单元格 hover 退出时触发",
+        "name": "cellMouseLeave",
+        "params": "(row, column, cell, event)"
+      },
+      {
+        "description": "当某个单元格被双击击时触发",
+        "name": "cellDblclick",
+        "params": "(row, column, cell, event)"
+      },
+      {
+        "description": "当某个单元格被鼠标右键点击时触发",
+        "name": "cellContextmenu",
+        "params": "(row, column, cell, event)"
+      },
+      {
+        "description": "当某个单元格被点击时触发",
+        "name": "cellClick",
+        "params": "(row, column, cell, event)"
+      },
+      {
+        "description": "当某一行被双击时触发",
+        "name": "rowDblclick",
+        "params": "(row, column, event)"
+      },
+      {
+        "description": "当某一行被点击时触发",
+        "name": "rowClick",
+        "params": "(row, column, event)"
+      },
+      {
+        "description": "当某一行被鼠标右键点击时触发",
+        "name": "rowContextmenu",
+        "params": "(row, column, event)"
+      },
+      {
+        "description": "当某一列的表头被点击时触发",
+        "name": "headerClick",
+        "params": "(column, event)"
+      },
+      {
+        "description": "当某一列的表头被鼠标右键点击时触发",
+        "name": "headerContextmenu",
+        "params": "(column, event)"
+      },
+      {
+        "description": "当表格的排序条件发生变化时触发",
+        "name": "sortChange",
+        "params": "({ column, prop, order })"
+      },
+      {
+        "description": "当表格的筛选条件发生变化时触发",
+        "name": "filterChange",
+        "params": "(filters)"
+      },
+      {
+        "description": "当表格的当前行发生变化时触发",
+        "name": "currentChange",
+        "params": "(currentRow, oldCurrentRow)"
+      },
+      {
+        "description": "拖动列宽结束后触发",
+        "name": "headerDragend",
+        "params": "(newWidth: number, oldWidth: number, column: TableColumnCtx, event: MouseEvent)"
+      },
+      {
+        "description": "当用户对某一行展开或关闭时触发",
+        "name": "expandChange",
+        "params": "(row, expandedRows | expanded)"
+      },
+      {
+        "description": "表格滚动时触发",
+        "name": "scroll",
+        "params": "({ scrollLeft, scrollTop }: { scrollLeft: number; scrollTop: number })"
+      }
+    ],
+    "exampleOmittedReason": null,
+    "examples": [
+      {
+        "code": "<script setup lang=\"ts\">\nimport { EpTable, EpTableColumn } from 'ep-craft'\n\nconst rows = [\n  { date: '2026-01-01', name: '张三', address: '杭州市西湖区' },\n  { date: '2026-01-02', name: '李四', address: '上海市浦东新区' },\n]\n</script>\n\n<template>\n  <ep-table :data=\"rows\">\n    <ep-table-column prop=\"date\" label=\"日期\" width=\"160\" />\n    <ep-table-column prop=\"name\" label=\"姓名\" width=\"120\" />\n    <ep-table-column prop=\"address\" label=\"地址\" />\n  </ep-table>\n</template>",
+        "id": "table-1",
+        "language": "vue",
+        "title": "基础表格"
+      },
+      {
+        "code": "<script setup lang=\"ts\">\nimport { EpTable, EpTableColumn } from 'ep-craft'\n\nconst rows = [\n  { date: '2026-01-01', name: '张三' },\n  { date: '2026-01-02', name: '李四' },\n]\n</script>\n\n<template>\n  <ep-table :data=\"rows\" stripe border>\n    <ep-table-column prop=\"date\" label=\"日期\" />\n    <ep-table-column prop=\"name\" label=\"姓名\" />\n  </ep-table>\n</template>",
+        "id": "table-2",
+        "language": "vue",
+        "title": "斑马纹与边框"
+      },
+      {
+        "code": "<script setup lang=\"ts\">\nimport { EpTable, EpTableColumn } from 'ep-craft'\n\nconst rows = [\n  { id: '1001', name: '张三', address: '杭州市西湖区文三路 20 号' },\n  { id: '1002', name: '李四', address: '上海市浦东新区世纪大道 100 号' },\n]\n</script>\n\n<template>\n  <ep-table :data=\"rows\" style=\"width: 100%\">\n    <ep-table-column prop=\"id\" label=\"编号\" width=\"120\" fixed=\"left\" />\n    <ep-table-column prop=\"name\" label=\"姓名\" width=\"120\" />\n    <ep-table-column prop=\"address\" label=\"地址\" width=\"360\" />\n  </ep-table>\n</template>",
+        "id": "table-3",
+        "language": "vue",
+        "title": "固定列"
+      }
+    ],
+    "exposes": [
+      {
+        "description": "清空用户的选择",
+        "name": "clearSelection",
+        "type": "() => void"
+      },
+      {
+        "description": "返回当前选中的行",
+        "name": "getSelectionRows",
+        "type": "() => any[]"
+      },
+      {
+        "description": "返回当前半选的行",
+        "name": "getHalfSelectionRows",
+        "type": "() => any[]"
+      },
+      {
+        "description": "切换某一行的选中状态",
+        "name": "toggleRowSelection",
+        "type": "(row: any, selected?: boolean) => void"
+      },
+      {
+        "description": "切换所有行的选中状态",
+        "name": "toggleAllSelection",
+        "type": "() => void"
+      },
+      {
+        "description": "切换某一行的展开状态",
+        "name": "toggleRowExpansion",
+        "type": "(row: any, expanded?: boolean) => void"
+      },
+      {
+        "description": "设置某一行为选中行",
+        "name": "setCurrentRow",
+        "type": "(row: any) => void"
+      },
+      {
+        "description": "清空排序条件",
+        "name": "clearSort",
+        "type": "() => void"
+      },
+      {
+        "description": "清空过滤条件",
+        "name": "clearFilter",
+        "type": "(columnKeys?: string[]) => void"
+      },
+      {
+        "description": "对 Table 进行重新布局",
+        "name": "doLayout",
+        "type": "() => void"
+      },
+      {
+        "description": "手动对 Table 进行排序",
+        "name": "sort",
+        "type": "(prop: string, order: string) => void"
+      },
+      {
+        "description": "懒加载表格中，更新某一行的子节点数据（需设置 row-key）",
+        "name": "updateKeyChildren",
+        "type": "(key: string, data: any[]) => void"
+      },
+      {
+        "description": "滚动到一组特定坐标",
+        "name": "scrollTo",
+        "type": "(options: ScrollToOptions | number, yCoord?: number) => void"
+      },
+      {
+        "description": "设置垂直滚动位置",
+        "name": "setScrollTop",
+        "type": "(top: number) => void"
+      },
+      {
+        "description": "设置水平滚动位置",
+        "name": "setScrollLeft",
+        "type": "(left: number) => void"
+      }
+    ],
+    "hot": true,
+    "id": "component:table",
+    "keywords": {
+      "en": [
+        "table",
+        "grid",
+        "datatable",
+        "data"
+      ],
+      "zh": [
+        "表格",
+        "数据表",
+        "列表",
+        "数据"
+      ]
+    },
+    "kind": "component",
+    "name": "EpTable",
+    "nonUseCases": [
+      "展示单个对象详情时使用 Descriptions"
+    ],
+    "props": [
+      {
+        "alias": null,
+        "defaultText": "[]",
+        "description": "显示的数据",
+        "hasDefault": true,
+        "name": "data",
+        "required": false,
+        "type": "any[]"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "Table 的尺寸",
+        "hasDefault": false,
+        "name": "size",
+        "required": false,
+        "type": "'large' | 'default' | 'small'"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": false,
+        "name": "width",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "Table 的高度",
+        "hasDefault": false,
+        "name": "height",
+        "required": false,
+        "type": "string | number"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "Table 的最大高度",
+        "hasDefault": false,
+        "name": "maxHeight",
+        "required": false,
+        "type": "string | number"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "列的宽度是否自撑开",
+        "hasDefault": true,
+        "name": "fit",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否为斑马纹 table",
+        "hasDefault": false,
+        "name": "stripe",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否带有纵向边框",
+        "hasDefault": false,
+        "name": "border",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "行数据的 Key",
+        "hasDefault": false,
+        "name": "rowKey",
+        "required": false,
+        "type": "string | ((row) => string)"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": false,
+        "name": "context",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "是否显示表头",
+        "hasDefault": true,
+        "name": "showHeader",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否在表尾显示合计行",
+        "hasDefault": false,
+        "name": "showSummary",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "合计",
+        "description": "合计行第一列的文本",
+        "hasDefault": false,
+        "name": "sumText",
+        "required": false,
+        "type": "string"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "自定义合计计算方法",
+        "hasDefault": false,
+        "name": "summaryMethod",
+        "required": false,
+        "type": "({ columns, data }) => string[]"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "行的 className 的回调方法",
+        "hasDefault": false,
+        "name": "rowClassName",
+        "required": false,
+        "type": "string | ((row, rowIndex) => string)"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "行的 style 的回调方法",
+        "hasDefault": false,
+        "name": "rowStyle",
+        "required": false,
+        "type": "object | ((row, rowIndex) => object)"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "单元格的 className 的回调方法",
+        "hasDefault": false,
+        "name": "cellClassName",
+        "required": false,
+        "type": "string | ((row, column, rowIndex, columnIndex) => string)"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "单元格的 style 的回调方法",
+        "hasDefault": false,
+        "name": "cellStyle",
+        "required": false,
+        "type": "object | ((row, column, rowIndex, columnIndex) => object)"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "表头行的 className 的回调",
+        "hasDefault": false,
+        "name": "headerRowClassName",
+        "required": false,
+        "type": "string | ((row, rowIndex) => string)"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "表头行的 style 的回调",
+        "hasDefault": false,
+        "name": "headerRowStyle",
+        "required": false,
+        "type": "object | ((row, rowIndex) => object)"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": false,
+        "name": "headerCellClassName",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": false,
+        "name": "headerCellStyle",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否要高亮当前行",
+        "hasDefault": false,
+        "name": "highlightCurrentRow",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "当前行的 key",
+        "hasDefault": false,
+        "name": "currentRowKey",
+        "required": false,
+        "type": "string | number"
+      },
+      {
+        "alias": null,
+        "defaultText": "暂无数据",
+        "description": "空数据时显示的文本内容",
+        "hasDefault": false,
+        "name": "emptyText",
+        "required": false,
+        "type": "string"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "可以通过该属性设置目前的展开行",
+        "hasDefault": false,
+        "name": "expandRowKeys",
+        "required": false,
+        "type": "string[]"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否默认展开所有行",
+        "hasDefault": false,
+        "name": "defaultExpandAll",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": false,
+        "name": "rowExpandable",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "默认的排序列和排序顺序",
+        "hasDefault": false,
+        "name": "defaultSort",
+        "required": false,
+        "type": "{ prop: string, order: 'ascending' | 'descending' }"
+      },
+      {
+        "alias": null,
+        "defaultText": "dark",
+        "description": "tooltip 效果",
+        "hasDefault": false,
+        "name": "tooltipEffect",
+        "required": false,
+        "type": "'dark' | 'light'"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": false,
+        "name": "tooltipOptions",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "合并行或列的计算方法",
+        "hasDefault": false,
+        "name": "spanMethod",
+        "required": false,
+        "type": "({ row, column, rowIndex, columnIndex }) => number[] | { rowspan: number, colspan: number }"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "全选勾选是否选择所有数据",
+        "hasDefault": true,
+        "name": "selectOnIndeterminate",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "16",
+        "description": "展示树形数据时缩进的大小",
+        "hasDefault": true,
+        "name": "indent",
+        "required": false,
+        "type": "number"
+      },
+      {
+        "alias": null,
+        "defaultText": "{ hasChildren: 'hasChildren', children: 'children' }",
+        "description": "渲染嵌套数据的配置选项",
+        "hasDefault": true,
+        "name": "treeProps",
+        "required": false,
+        "type": "{ hasChildren: string, children: string }"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否懒加载子节点数据",
+        "hasDefault": false,
+        "name": "lazy",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "加载子节点数据的函数",
+        "hasDefault": false,
+        "name": "load",
+        "required": false,
+        "type": "(row, treeNode, resolve) => void"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": true,
+        "name": "className",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": true,
+        "name": "style",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": "fixed",
+        "description": "表格布局方式",
+        "hasDefault": true,
+        "name": "tableLayout",
+        "required": false,
+        "type": "'fixed' | 'auto'"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否总是显示滚动条",
+        "hasDefault": false,
+        "name": "scrollbarAlwaysOn",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "确保主轴的最小尺寸",
+        "hasDefault": false,
+        "name": "flexible",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": true,
+        "name": "showOverflowTooltip",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": false,
+        "name": "tooltipFormatter",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": false,
+        "name": "appendFilterPanelTo",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": true,
+        "name": "scrollbarTabindex",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": true,
+        "name": "allowDragLastColumn",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": false,
+        "name": "preserveExpandedContent",
+        "required": false,
+        "type": "unknown"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "",
+        "hasDefault": false,
+        "name": "nativeScrollbar",
+        "required": false,
+        "type": "unknown"
+      }
+    ],
+    "related": [
+      "EpTableColumn"
+    ],
+    "relations": {
+      "children": [
+        "EpTableColumn"
+      ],
+      "combos": [
+        "EpTable + EpTableColumn"
+      ],
+      "parents": [],
+      "requiredChildren": []
+    },
+    "slots": [
+      {
+        "description": "自定义默认内容",
+        "name": "default"
+      },
+      {
+        "description": "插入至表格最后一行之后的内容",
+        "name": "append"
+      },
+      {
+        "description": "当数据为空时自定义的内容",
+        "name": "empty"
+      }
+    ],
+    "slug": "table",
+    "summary": "数据表格，支持排序、筛选与固定列",
+    "tag": "ep-table",
+    "useCases": [
+      "展示结构化列表数据",
+      "排序、筛选与分页浏览"
+    ],
+    "variants": [
+      {
+        "dimension": "size",
+        "values": [
+          "large",
+          "default",
+          "small"
+        ],
+        "when": "按容器空间与信息密度选择尺寸"
+      },
+      {
+        "dimension": "effect",
+        "values": [
+          "border"
+        ],
+        "when": "通过视觉修饰属性调整外观效果"
+      }
+    ],
+    "visual": {
+      "cssVars": [
+        "--el-border-color-lighter",
+        "--el-bg-color",
+        "--el-text-color-regular",
+        "--el-font-size-base"
+      ],
+      "density": "紧凑",
+      "shape": "块级数据区域",
+      "slotContent": [
+        "default：自定义默认内容",
+        "append：插入至表格最后一行之后的内容",
+        "empty：当数据为空时自定义的内容"
+      ]
+    }
+  },
+  "generatedAt": "2026-11-03T03:09:12.050Z",
+  "libraryVersion": "0.2.0",
+  "schemaVersion": 1
+}