ep-craft 0.1.41 → 0.2.0

package/dist-ai/components/tour.md

@@ -0,0 +1,96 @@
+# EpTour
+
+`ep-tour` · feedback（反馈） · `component:tour`
+
+## 摘要
+
+漫游式引导，状态与结果反馈
+
+## 适用场景
+
+- 适用：展示漫游式引导并向用户传达状态
+- 适用：在操作前后提供即时反馈
+- 不适用：无需用户感知状态变化时
+- 不适用：需要完整业务弹窗流程时优先使用 Dialog
+
+## 关键词
+
+- 中文：漫游式引导、反馈
+- English: tour, guide, feedback
+
+## 变体
+
+- type: default/primary（通过 type 选择类型，影响背景色与文字颜色）
+
+## Props
+
+- modelValue（别名 v-model） (boolean)：是否打开引导
+- current (number)：当前步骤索引
+- showArrow (boolean，默认 true)：是否显示箭头
+- showClose (boolean，默认 true)：是否显示关闭按钮
+- closeIcon (string | Component)：自定义关闭图标
+- placement (Placement，默认 bottom)：引导卡片相对目标元素的位置
+- contentStyle (CSSProperties)：内容自定义样式
+- mask (boolean | TourMask，默认 true)：是否启用遮罩，可传对象自定义样式与填充色
+- gap ({ offset?: number; radius?: number }，默认 { offset: 6, radius: 2 })：遮罩与目标元素之间的间隙
+- zIndex (number)：引导层 z-index
+- scrollIntoViewOptions (boolean | ScrollIntoViewOptions，默认 { block: "center" })：自定义 scrollIntoView 配置
+- type ('default' | 'primary')：类型，影响背景色与文字颜色
+- appendTo (string | HTMLElement，默认 body)：引导内容挂载的容器
+- closeOnPressEscape (boolean，默认 true)：按 ESC 是否关闭引导
+- targetAreaClickable (boolean，默认 true)：使用遮罩时目标区域是否可点击
+
+## Events
+
+- update:modelValue((value: boolean))：打开状态变化时触发
+- update:current((current: number))：当前步骤变化时触发
+- close((current: number))：关闭引导时触发
+- finish(—)：完成全部步骤时触发
+- change((current: number))：当前步骤变化时触发
+
+## Slots
+
+- default：步骤内容，通常放置 ep-tour-step
+- indicators：自定义步骤指示器，参数为 `{ current, total }`
+
+## 关系
+
+- 子级：EpTourStep
+- 必需子组件：EpTourStep
+- 常用组合：EpTour + EpTourStep
+
+## 视觉提示
+
+- 形状：行内或块级提示
+- 密度：中等
+- 插槽内容：default：步骤内容，通常放置 ep-tour-step；indicators：自定义步骤指示器，参数为 `{ current, total }`
+- CSS 变量：--el-color-success、--el-color-warning、--el-color-danger、--el-font-size-base
+
+## 示例
+
+### 漫游引导
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue'
+import { EpButton, EpTour, EpTourStep } from 'ep-craft'
+
+const open = ref(false)
+</script>
+
+<template>
+  <ep-button id="tour-target" type="primary" @click="open = true">新建项目</ep-button>
+  <ep-tour v-model="open">
+    <ep-tour-step target="#tour-target" title="第一步" description="点击这里创建项目" />
+  </ep-tour>
+</template>
+```
+
+## 相关条目
+
+- EpTourStep
+- EpDialog
+
+---
+
+ep-craft 0.2.0

package/dist-ai/components/transfer.json

@@ -0,0 +1,275 @@
+{
+  "entry": {
+    "category": "form",
+    "events": [
+      {
+        "description": "数据移动时触发",
+        "name": "change",
+        "params": "(value: TransferKey[], direction: \"left\" | \"right\", movedKeys: TransferKey[])"
+      },
+      {
+        "description": "绑定值变化时触发",
+        "name": "update:modelValue",
+        "params": "(value: TransferKey[])"
+      },
+      {
+        "description": "左侧列表勾选变化时触发",
+        "name": "leftCheckChange",
+        "params": "(value: TransferKey[], movedKeys?: TransferKey[])"
+      },
+      {
+        "description": "右侧列表勾选变化时触发",
+        "name": "rightCheckChange",
+        "params": "(value: TransferKey[], movedKeys?: TransferKey[])"
+      }
+    ],
+    "exampleOmittedReason": null,
+    "examples": [
+      {
+        "code": "<script setup lang=\"ts\">\nimport { ref } from 'vue'\nimport { EpTransfer } from 'ep-craft'\n\nconst value = ref([1])\nconst data = Array.from({ length: 6 }, (_, index) => ({\n  key: index + 1,\n  label: `选项 ${index + 1}`,\n}))\n</script>\n\n<template>\n  <ep-transfer v-model=\"value\" :data=\"data\" :titles=\"['待选', '已选']\" />\n</template>",
+        "id": "transfer-1",
+        "language": "vue",
+        "title": "穿梭框"
+      }
+    ],
+    "exposes": [
+      {
+        "description": "清空指定面板的过滤关键词",
+        "name": "clearQuery",
+        "type": "(direction: 'left' | 'right') => void"
+      },
+      {
+        "description": "左侧面板实例",
+        "name": "leftPanel",
+        "type": "TransferPanelInstance | undefined"
+      },
+      {
+        "description": "右侧面板实例",
+        "name": "rightPanel",
+        "type": "TransferPanelInstance | undefined"
+      }
+    ],
+    "hot": false,
+    "id": "component:transfer",
+    "keywords": {
+      "en": [
+        "transfer",
+        "shuttle",
+        "form"
+      ],
+      "zh": [
+        "穿梭框",
+        "表单"
+      ]
+    },
+    "kind": "component",
+    "name": "EpTransfer",
+    "nonUseCases": [
+      "仅展示静态文本或只读数据时"
+    ],
+    "props": [
+      {
+        "alias": null,
+        "defaultText": "[]",
+        "description": "数据源",
+        "hasDefault": true,
+        "name": "data",
+        "required": false,
+        "type": "TransferDataItem[]"
+      },
+      {
+        "alias": null,
+        "defaultText": "[]",
+        "description": "自定义列表标题",
+        "hasDefault": true,
+        "name": "titles",
+        "required": false,
+        "type": "[string, string]"
+      },
+      {
+        "alias": null,
+        "defaultText": "[]",
+        "description": "自定义按钮文本",
+        "hasDefault": true,
+        "name": "buttonTexts",
+        "required": false,
+        "type": "[string, string]"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "过滤输入框占位符",
+        "hasDefault": false,
+        "name": "filterPlaceholder",
+        "required": false,
+        "type": "string"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "自定义过滤方法",
+        "hasDefault": false,
+        "name": "filterMethod",
+        "required": false,
+        "type": "(query: string, item: T) => boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "[]",
+        "description": "左侧列表初始勾选的 key 数组",
+        "hasDefault": true,
+        "name": "leftDefaultChecked",
+        "required": false,
+        "type": "TransferKey[]"
+      },
+      {
+        "alias": null,
+        "defaultText": "[]",
+        "description": "右侧列表初始勾选的 key 数组",
+        "hasDefault": true,
+        "name": "rightDefaultChecked",
+        "required": false,
+        "type": "TransferKey[]"
+      },
+      {
+        "alias": null,
+        "defaultText": null,
+        "description": "自定义数据项渲染函数",
+        "hasDefault": false,
+        "name": "renderContent",
+        "required": false,
+        "type": "(h, option) => VNode | VNode[]"
+      },
+      {
+        "alias": "v-model",
+        "defaultText": "[]",
+        "description": "绑定值，右侧列表的数据项 key 数组",
+        "hasDefault": true,
+        "name": "modelValue",
+        "required": false,
+        "type": "TransferKey[]"
+      },
+      {
+        "alias": null,
+        "defaultText": "{}",
+        "description": "列表头部勾选状态文案",
+        "hasDefault": true,
+        "name": "format",
+        "required": false,
+        "type": "{ noChecked?: string; hasChecked?: string }"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否可过滤",
+        "hasDefault": false,
+        "name": "filterable",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "{ label: 'label', key: 'key', disabled: 'disabled' }",
+        "description": "数据源字段别名",
+        "hasDefault": true,
+        "name": "props",
+        "required": false,
+        "type": "{ label?: string; key?: string; disabled?: string }"
+      },
+      {
+        "alias": null,
+        "defaultText": "original",
+        "description": "右侧列表排序策略",
+        "hasDefault": true,
+        "name": "targetOrder",
+        "required": false,
+        "type": "'original' | 'push' | 'unshift'"
+      },
+      {
+        "alias": null,
+        "defaultText": "true",
+        "description": "是否触发表单校验",
+        "hasDefault": true,
+        "name": "validateEvent",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "false",
+        "description": "是否启用虚拟滚动",
+        "hasDefault": true,
+        "name": "virtualScroll",
+        "required": false,
+        "type": "boolean"
+      },
+      {
+        "alias": null,
+        "defaultText": "30",
+        "description": "虚拟滚动下的行高",
+        "hasDefault": true,
+        "name": "itemSize",
+        "required": false,
+        "type": "number"
+      }
+    ],
+    "related": [
+      "EpTable",
+      "EpCheckbox"
+    ],
+    "relations": {
+      "children": [],
+      "combos": [],
+      "parents": [],
+      "requiredChildren": []
+    },
+    "slots": [
+      {
+        "description": "自定义数据项内容，参数为 `{ option }`",
+        "name": "default"
+      },
+      {
+        "description": "左侧列表为空时的内容",
+        "name": "left-empty"
+      },
+      {
+        "description": "右侧列表为空时的内容",
+        "name": "right-empty"
+      },
+      {
+        "description": "左侧列表底部内容",
+        "name": "left-footer"
+      },
+      {
+        "description": "右侧列表底部内容",
+        "name": "right-footer"
+      }
+    ],
+    "slug": "transfer",
+    "summary": "穿梭框，表单数据录入控件",
+    "tag": "ep-transfer",
+    "useCases": [
+      "表单中收集或编辑穿梭框数据",
+      "与 EpForm、EpFormItem 组合完成校验"
+    ],
+    "variants": [],
+    "visual": {
+      "cssVars": [
+        "--el-border-color",
+        "--el-border-radius-base",
+        "--el-color-primary",
+        "--el-font-size-base"
+      ],
+      "density": "中等",
+      "shape": "矩形输入框",
+      "slotContent": [
+        "default：自定义数据项内容，参数为 `{ option }`",
+        "left-empty：左侧列表为空时的内容",
+        "right-empty：右侧列表为空时的内容"
+      ]
+    }
+  },
+  "generatedAt": "2026-11-03T03:09:12.050Z",
+  "libraryVersion": "0.2.0",
+  "schemaVersion": 1
+}

package/dist-ai/components/transfer.md

@@ -0,0 +1,95 @@
+# EpTransfer
+
+`ep-transfer` · form（表单） · `component:transfer`
+
+## 摘要
+
+穿梭框，表单数据录入控件
+
+## 适用场景
+
+- 适用：表单中收集或编辑穿梭框数据
+- 适用：与 EpForm、EpFormItem 组合完成校验
+- 不适用：仅展示静态文本或只读数据时
+
+## 关键词
+
+- 中文：穿梭框、表单
+- English: transfer, shuttle, form
+
+## Props
+
+- data (TransferDataItem[]，默认 [])：数据源
+- titles ([string, string]，默认 [])：自定义列表标题
+- buttonTexts ([string, string]，默认 [])：自定义按钮文本
+- filterPlaceholder (string)：过滤输入框占位符
+- filterMethod ((query: string, item: T) => boolean)：自定义过滤方法
+- leftDefaultChecked (TransferKey[]，默认 [])：左侧列表初始勾选的 key 数组
+- rightDefaultChecked (TransferKey[]，默认 [])：右侧列表初始勾选的 key 数组
+- renderContent ((h, option) => VNode | VNode[])：自定义数据项渲染函数
+- modelValue（别名 v-model） (TransferKey[]，默认 [])：绑定值，右侧列表的数据项 key 数组
+- format ({ noChecked?: string; hasChecked?: string }，默认 {})：列表头部勾选状态文案
+- filterable (boolean)：是否可过滤
+- props ({ label?: string; key?: string; disabled?: string }，默认 { label: 'label', key: 'key', disabled: 'disabled' })：数据源字段别名
+- targetOrder ('original' | 'push' | 'unshift'，默认 original)：右侧列表排序策略
+- validateEvent (boolean，默认 true)：是否触发表单校验
+- virtualScroll (boolean，默认 false)：是否启用虚拟滚动
+- itemSize (number，默认 30)：虚拟滚动下的行高
+
+## Events
+
+- change((value: TransferKey[], direction: "left" | "right", movedKeys: TransferKey[]))：数据移动时触发
+- update:modelValue((value: TransferKey[]))：绑定值变化时触发
+- leftCheckChange((value: TransferKey[], movedKeys?: TransferKey[]))：左侧列表勾选变化时触发
+- rightCheckChange((value: TransferKey[], movedKeys?: TransferKey[]))：右侧列表勾选变化时触发
+
+## Slots
+
+- default：自定义数据项内容，参数为 `{ option }`
+- left-empty：左侧列表为空时的内容
+- right-empty：右侧列表为空时的内容
+- left-footer：左侧列表底部内容
+- right-footer：右侧列表底部内容
+
+## Exposes
+
+- clearQuery((direction: 'left' | 'right') => void)：清空指定面板的过滤关键词
+- leftPanel(TransferPanelInstance | undefined)：左侧面板实例
+- rightPanel(TransferPanelInstance | undefined)：右侧面板实例
+
+## 视觉提示
+
+- 形状：矩形输入框
+- 密度：中等
+- 插槽内容：default：自定义数据项内容，参数为 `{ option }`；left-empty：左侧列表为空时的内容；right-empty：右侧列表为空时的内容
+- CSS 变量：--el-border-color、--el-border-radius-base、--el-color-primary、--el-font-size-base
+
+## 示例
+
+### 穿梭框
+
+```vue
+<script setup lang="ts">
+import { ref } from 'vue'
+import { EpTransfer } from 'ep-craft'
+
+const value = ref([1])
+const data = Array.from({ length: 6 }, (_, index) => ({
+  key: index + 1,
+  label: `选项 ${index + 1}`,
+}))
+</script>
+
+<template>
+  <ep-transfer v-model="value" :data="data" :titles="['待选', '已选']" />
+</template>
+```
+
+## 相关条目
+
+- EpTable
+- EpCheckbox
+
+---
+
+ep-craft 0.2.0