ep-craft 0.1.41 → 0.2.0

package/dist-ai/components/tree.json

@@ -0,0 +1,485 @@
+{
+  "entry": {
+    "category": "data",
+    "events": [
+      {
+        "description": "节点勾选状态变化时触发",
+        "name": "checkChange",
+        "params": "(data, checked: boolean, indeterminate: boolean)"
+      },
+      {
+        "description": "当前选中节点变化时触发",
+        "name": "currentChange",
+        "params": "(data, node)"
+      },
+      {
+        "description": "点击节点时触发",
+        "name": "nodeClick",
+        "params": "(data, node, nodeInstance, evt: MouseEvent)"
+      },
+      {
+        "description": "右键节点时触发",
+        "name": "nodeContextmenu",
+        "params": "(evt: Event, data, node, nodeInstance)"
+      },
+      {
+        "description": "节点收起时触发",
+        "name": "nodeCollapse",
+        "params": "(data, node, nodeInstance)"
+      },
+      {
+        "description": "节点展开时触发",
+        "name": "nodeExpand",
+        "params": "(data, node, nodeInstance)"
+      },
+      {
+        "description": "勾选节点时触发",
+        "name": "check",
+        "params": "(data, checkedInfo: CheckedInfo)"
+      },
+      {
+        "description": "节点开始拖拽时触发",
+        "name": "nodeDragStart",
+        "params": "(node, evt: DragEvent)"
+      },
+      {
+        "description": "拖拽结束时触发",
+        "name": "nodeDragEnd",
+        "params": "(draggingNode, dropNode, dropType, evt: DragEvent)"
+      },
+      {
+        "description": "拖拽放置后触发",
+        "name": "nodeDrop",
+        "params": "(draggingNode, dropNode, dropType, evt: DragEvent)"
+      },
+      {
+        "description": "拖拽离开节点时触发",
+        "name": "nodeDragLeave",
+        "params": "(draggingNode, oldDropNode, evt: DragEvent)"
+      },
+      {
+        "description": "拖拽进入节点时触发",
+        "name": "nodeDragEnter",
+        "params": "(draggingNode, dropNode, evt: DragEvent)"
+      },
+      {
+        "description": "拖拽在节点上时触发",
+        "name": "nodeDragOver",
+        "params": "(draggingNode, dropNode, evt: DragEvent)"
+      }
+    ],
+    "exampleOmittedReason": null,
+    "examples": [
+      {
+        "code": "<script setup lang=\"ts\">\nimport { EpTree } from 'ep-craft'\n\nconst data = [\n  {\n    id: 'root',\n    label: '根节点',\n    children: [\n      { id: 'child-1', label: '子节点一' },\n      { id: 'child-2', label: '子节点二' },\n    ],\n  },\n]\n</script>\n\n<template>\n  <ep-tree :data=\"data\" node-key=\"id\" default-expand-all show-checkbox />\n</template>",
+        "id": "tree-1",
+        "language": "vue",
+        "title": "树形控件"
+      }
+    ],
+    "exposes": [
+      {
+        "description": "过滤节点",
+        "name": "filter",
+        "type": "(value: any) => void"
+      },
+      {
+        "description": "获取勾选节点",
+        "name": "getCheckedNodes",
+        "type": "(leafOnly?: boolean) => Node[]"
+      },
+      {
+        "description": "设置勾选节点",
+        "name": "setCheckedNodes",
+        "type": "(nodes: Node[]) => void"
+      },
+      {
+        "description": "获取勾选节点的 key",
+        "name": "getCheckedKeys",
+        "type": "(leafOnly?: boolean) => TreeKey[]"
+      },
+      {
+        "description": "设置勾选节点的 key",
+        "name": "setCheckedKeys",
+        "type": "(keys: TreeKey[]) => void"
+      },
+      {
+        "description": "设置节点勾选状态",
+        "name": "setChecked",
+        "type": "(data: TreeKey | Node, checked: boolean, deep: boolean) => void"
+      },
+      {
+        "description": "获取半选节点",
+        "name": "getHalfCheckedNodes",
+        "type": "() => Node[]"
+      },
+      {
+        "description": "获取半选节点的 key",
+        "name": "getHalfCheckedKeys",
+        "type": "() => TreeKey[]"
+      },
+      {
+        "description": "获取当前选中节点的 key",
+        "name": "getCurrentKey",
+        "type": "() => TreeKey | undefined"
+      },
+      {
+        "description": "获取当前选中节点",
+        "name": "getCurrentNode",
+        "type": "() => Node | undefined"
+      },
+      {
+        "description": "设置当前选中节点的 key",
+        "name": "setCurrentKey",
+        "type": "(key: TreeKey) => void"
+      },
+      {
+        "description": "设置当前选中节点",
+        "name": "setCurrentNode",
+        "type": "(node: Node) => void"
+      },
+      {
+        "description": "根据 key 或 data 获取节点",
+        "name": "getNode",
+        "type": "(data: TreeKey | TreeNodeData) => Node"
+      },
+      {
+        "description": "删除节点",
+        "name": "remove",
+        "type": "(data: TreeKey | Node) => void"
+      },
+      {
+        "description": "追加子节点",
+        "name": "append",
+        "type": "(data: TreeKey | Node, child: TreeNodeData) => void"
+      },
+      {
+        "description": "在节点前插入",
+        "name": "insertBefore",
+        "type": "(data: TreeKey | Node, child: TreeNodeData) => void"
+      },
+      {
+        "description": "在节点后插入",
+        "name": "insertAfter",
+        "type": "(data: TreeKey | Node, child: TreeNodeData) => void"
+      },
+      {
+        "description": "更新子节点的 key",
+        "name": "updateKeyChildren",
+        "type": "(key: TreeKey, data: TreeNodeData[]) => void"
+      }
+    ],
+    "hot": true,
+    "id": "component:tree",
+    "keywords": {
+      "en": [
+        "tree",
+        "treeview",
+        "hierarchy",
+        "data"
+      ],
+      "zh": [
+        "树形控件",
+        "树",
+        "树形",
+        "层级",
+        "数据"
+      ]
+    },
+    "kind": "component",
+    "name": "EpTree",
+    "nonUseCases": [
+      "数据量极小且无需结构化展示时"
+    ],
+    "props": [
+      {
+        "alias": null,
+        "defaultText": "[]",
+        "description": "展示数据",
+        "hasDefault": true,
+        "name": "data",
+        "required": false,
+        "type": "TreeData"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "内容为空时的文本",
+        "hasDefault": false,
+        "name": "emptyText",
+        "required": false,
+        "type": "string"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "是否在第一次展开时才渲染子节点",
+        "hasDefault": true,
+        "name": "renderAfterExpand",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "每个树节点唯一标识的属性名",
+        "hasDefault": false,
+        "name": "nodeKey",
+        "required": false,
+        "type": "string"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "勾选时是否不关联父子节点",
+        "hasDefault": false,
+        "name": "checkStrictly",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否默认展开所有节点",
+        "hasDefault": false,
+        "name": "defaultExpandAll",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "点击节点时是否展开/收起",
+        "hasDefault": true,
+        "name": "expandOnClickNode",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "点击节点时是否勾选/取消勾选",
+        "hasDefault": false,
+        "name": "checkOnClickNode",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "点击叶子节点时是否勾选",
+        "hasDefault": true,
+        "name": "checkOnClickLeaf",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "勾选时是否影响后代节点",
+        "hasDefault": false,
+        "name": "checkDescendants",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "是否自动展开父节点",
+        "hasDefault": true,
+        "name": "autoExpandParent",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "默认勾选的节点 key 数组",
+        "hasDefault": false,
+        "name": "defaultCheckedKeys",
+        "required": false,
+        "type": "TreeKey[]"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "默认展开的节点 key 数组",
+        "hasDefault": false,
+        "name": "defaultExpandedKeys",
+        "required": false,
+        "type": "TreeKey[]"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "当前选中节点的 key",
+        "hasDefault": false,
+        "name": "currentNodeKey",
+        "required": false,
+        "type": "string | number"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "自定义节点内容渲染函数",
+        "hasDefault": false,
+        "name": "renderContent",
+        "required": false,
+        "type": "RenderContentFunction"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否显示复选框",
+        "hasDefault": false,
+        "name": "showCheckbox",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否开启拖拽",
+        "hasDefault": false,
+        "name": "draggable",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "判断节点能否被拖拽",
+        "hasDefault": false,
+        "name": "allowDrag",
+        "required": false,
+        "type": "AllowDragFunction"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "判断节点能否被放置",
+        "hasDefault": false,
+        "name": "allowDrop",
+        "required": false,
+        "type": "AllowDropFunction"
+      },
+      {
+        "alias": null,
+        "defaultText": "{ children: 'children', label: 'label', disabled: 'disabled' }",
+        "description": "配置选项",
+        "hasDefault": true,
+        "name": "props",
+        "required": false,
+        "type": "{ children?: string; label?: string; disabled?: string }"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否懒加载子节点，需配合 load 使用",
+        "hasDefault": false,
+        "name": "lazy",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否高亮当前选中节点",
+        "hasDefault": false,
+        "name": "highlightCurrent",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "加载子节点的方法",
+        "hasDefault": false,
+        "name": "load",
+        "required": false,
+        "type": "(node, resolve, reject) => void"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "过滤节点的函数",
+        "hasDefault": false,
+        "name": "filterNodeMethod",
+        "required": false,
+        "type": "(value, data, node) => boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否每次只展开一个同级节点",
+        "hasDefault": false,
+        "name": "accordion",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "18",
+        "description": "相邻级节点的缩进，单位 px",
+        "hasDefault": true,
+        "name": "indent",
+        "required": false,
+        "type": "number"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "自定义节点图标",
+        "hasDefault": false,
+        "name": "icon",
+        "required": false,
+        "type": "string | Component"
+      }
+    ],
+    "related": [
+      "EpTreeSelect",
+      "EpTreeV2"
+    ],
+    "relations": {
+      "children": [],
+      "combos": [],
+      "parents": [],
+      "requiredChildren": []
+    },
+    "slots": [
+      {
+        "description": "自定义节点内容，参数为 `{ node, data }`",
+        "name": "default"
+      },
+      {
+        "description": "内容为空时的内容",
+        "name": "empty"
+      }
+    ],
+    "slug": "tree",
+    "summary": "树形控件，展示层级数据与展开选择",
+    "tag": "ep-tree",
+    "useCases": [
+      "文件夹、组织架构等层级数据",
+      "需要展开、勾选或拖拽的树形选择"
+    ],
+    "variants": [],
+    "visual": {
+      "cssVars": [
+        "--el-border-color-lighter",
+        "--el-bg-color",
+        "--el-text-color-regular",
+        "--el-font-size-base"
+      ],
+      "density": "紧凑",
+      "shape": "块级数据区域",
+      "slotContent": [
+        "default：自定义节点内容，参数为 `{ node, data }`",
+        "empty：内容为空时的内容"
+      ]
+    }
+  },
+  "generatedAt": "2026-11-03T03:09:12.050Z",
+  "libraryVersion": "0.2.0",
+  "schemaVersion": 1
+}

package/dist-ai/components/tree.md

@@ -0,0 +1,131 @@
+# EpTree
+
+`ep-tree` · data（数据展示） · `component:tree`
+
+## 摘要
+
+树形控件，展示层级数据与展开选择
+
+## 适用场景
+
+- 适用：文件夹、组织架构等层级数据
+- 适用：需要展开、勾选或拖拽的树形选择
+- 不适用：数据量极小且无需结构化展示时
+
+## 关键词
+
+- 中文：树形控件、树、树形、层级、数据
+- English: tree, treeview, hierarchy, data
+
+## Props
+
+- data (TreeData，默认 [])：展示数据
+- emptyText (string)：内容为空时的文本
+- renderAfterExpand (boolean，默认 true)：是否在第一次展开时才渲染子节点
+- nodeKey (string)：每个树节点唯一标识的属性名
+- checkStrictly (boolean)：勾选时是否不关联父子节点
+- defaultExpandAll (boolean)：是否默认展开所有节点
+- expandOnClickNode (boolean，默认 true)：点击节点时是否展开/收起
+- checkOnClickNode (boolean)：点击节点时是否勾选/取消勾选
+- checkOnClickLeaf (boolean，默认 true)：点击叶子节点时是否勾选
+- checkDescendants (boolean)：勾选时是否影响后代节点
+- autoExpandParent (boolean，默认 true)：是否自动展开父节点
+- defaultCheckedKeys (TreeKey[])：默认勾选的节点 key 数组
+- defaultExpandedKeys (TreeKey[])：默认展开的节点 key 数组
+- currentNodeKey (string | number)：当前选中节点的 key
+- renderContent (RenderContentFunction)：自定义节点内容渲染函数
+- showCheckbox (boolean)：是否显示复选框
+- draggable (boolean)：是否开启拖拽
+- allowDrag (AllowDragFunction)：判断节点能否被拖拽
+- allowDrop (AllowDropFunction)：判断节点能否被放置
+- props ({ children?: string; label?: string; disabled?: string }，默认 { children: 'children', label: 'label', disabled: 'disabled' })：配置选项
+- lazy (boolean)：是否懒加载子节点，需配合 load 使用
+- highlightCurrent (boolean)：是否高亮当前选中节点
+- load ((node, resolve, reject) => void)：加载子节点的方法
+- filterNodeMethod ((value, data, node) => boolean)：过滤节点的函数
+- accordion (boolean)：是否每次只展开一个同级节点
+- indent (number，默认 18)：相邻级节点的缩进，单位 px
+- icon (string | Component)：自定义节点图标
+
+## Events
+
+- checkChange((data, checked: boolean, indeterminate: boolean))：节点勾选状态变化时触发
+- currentChange((data, node))：当前选中节点变化时触发
+- nodeClick((data, node, nodeInstance, evt: MouseEvent))：点击节点时触发
+- nodeContextmenu((evt: Event, data, node, nodeInstance))：右键节点时触发
+- nodeCollapse((data, node, nodeInstance))：节点收起时触发
+- nodeExpand((data, node, nodeInstance))：节点展开时触发
+- check((data, checkedInfo: CheckedInfo))：勾选节点时触发
+- nodeDragStart((node, evt: DragEvent))：节点开始拖拽时触发
+- nodeDragEnd((draggingNode, dropNode, dropType, evt: DragEvent))：拖拽结束时触发
+- nodeDrop((draggingNode, dropNode, dropType, evt: DragEvent))：拖拽放置后触发
+- nodeDragLeave((draggingNode, oldDropNode, evt: DragEvent))：拖拽离开节点时触发
+- nodeDragEnter((draggingNode, dropNode, evt: DragEvent))：拖拽进入节点时触发
+- nodeDragOver((draggingNode, dropNode, evt: DragEvent))：拖拽在节点上时触发
+
+## Slots
+
+- default：自定义节点内容，参数为 `{ node, data }`
+- empty：内容为空时的内容
+
+## Exposes
+
+- filter((value: any) => void)：过滤节点
+- getCheckedNodes((leafOnly?: boolean) => Node[])：获取勾选节点
+- setCheckedNodes((nodes: Node[]) => void)：设置勾选节点
+- getCheckedKeys((leafOnly?: boolean) => TreeKey[])：获取勾选节点的 key
+- setCheckedKeys((keys: TreeKey[]) => void)：设置勾选节点的 key
+- setChecked((data: TreeKey | Node, checked: boolean, deep: boolean) => void)：设置节点勾选状态
+- getHalfCheckedNodes(() => Node[])：获取半选节点
+- getHalfCheckedKeys(() => TreeKey[])：获取半选节点的 key
+- getCurrentKey(() => TreeKey | undefined)：获取当前选中节点的 key
+- getCurrentNode(() => Node | undefined)：获取当前选中节点
+- setCurrentKey((key: TreeKey) => void)：设置当前选中节点的 key
+- setCurrentNode((node: Node) => void)：设置当前选中节点
+- getNode((data: TreeKey | TreeNodeData) => Node)：根据 key 或 data 获取节点
+- remove((data: TreeKey | Node) => void)：删除节点
+- append((data: TreeKey | Node, child: TreeNodeData) => void)：追加子节点
+- insertBefore((data: TreeKey | Node, child: TreeNodeData) => void)：在节点前插入
+- insertAfter((data: TreeKey | Node, child: TreeNodeData) => void)：在节点后插入
+- updateKeyChildren((key: TreeKey, data: TreeNodeData[]) => void)：更新子节点的 key
+
+## 视觉提示
+
+- 形状：块级数据区域
+- 密度：紧凑
+- 插槽内容：default：自定义节点内容，参数为 `{ node, data }`；empty：内容为空时的内容
+- CSS 变量：--el-border-color-lighter、--el-bg-color、--el-text-color-regular、--el-font-size-base
+
+## 示例
+
+### 树形控件
+
+```vue
+<script setup lang="ts">
+import { EpTree } from 'ep-craft'
+
+const data = [
+  {
+    id: 'root',
+    label: '根节点',
+    children: [
+      { id: 'child-1', label: '子节点一' },
+      { id: 'child-2', label: '子节点二' },
+    ],
+  },
+]
+</script>
+
+<template>
+  <ep-tree :data="data" node-key="id" default-expand-all show-checkbox />
+</template>
+```
+
+## 相关条目
+
+- EpTreeSelect
+- EpTreeV2
+
+---
+
+ep-craft 0.2.0